curb 0.9.8 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64402c665924d5c24d6fa01dff9dd9f41d522ef1ca6e663d2038a204bd0290b4
-  data.tar.gz: 645f0b0f29804b105b9a4caaa1b2132d9d18b5dd4d678072e7e41a1d8d73771a
+  metadata.gz: e28b1d05b46460867acfadc87bbe422d58d8f2cdb93397fa6ded906b01cd7dab
+  data.tar.gz: 33e7037c1c2b23a793ec96c73bc80c008939c880702f884d2b258d4afd18c368
 SHA512:
-  metadata.gz: f86cb2a29633a86820862e35a5a1113c859e55636a50e779ab4235ccc54fb3b38a894edb8fcc090522ceb509ac0c2da329f708a9c109a2f871ce9c718984729c
-  data.tar.gz: a2d20ac0b5aee80de2aa37f4c49b923c5e6b19c2b0dd82d4466d14b21f0988644baa893bd23950380efec0ab028c9f1fd9c1dfc6d2ab7c97246c86bb2aad5cf2
+  metadata.gz: 6eb448726a4fdce1e0832e36a45b2c8e0a078fbc2c04b3fe34f87fc38397f5c4ecc4fe621aed5637750c5c7a7a9d05b30c03f9f7db153c23d3694eb6adb464e8
+  data.tar.gz: 624e3f39af79eff874784a662776debc2b405378c6cdc963a50dee525d36aa225cc5f40558f9b35b396c222416006f66c29fc6193e651b5aa84093fdd52cb2ba

data/README.markdown

@@ -1,25 +1,77 @@
-# Curb - Libcurl bindings for Ruby [![Build Status](https://travis-ci.org/taf2/curb.svg?branch=master)](https://travis-ci.org/taf2/curb)
+# Curb - Libcurl bindings for Ruby
 
+* [CI Build Status](https://github.com/taf2/curb/actions/workflows/CI.yml)
 * [rubydoc rdoc](http://www.rubydoc.info/github/taf2/curb/)
 * [github project](http://github.com/taf2/curb/tree/master)
 
 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/) .
+cURL and libcurl live at [https://curl.se/libcurl/](https://curl.se/libcurl/) .
 
-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
+Curb is copyright (c) 2006 Ross Bamford, and released under the terms of the
 Ruby license. See the LICENSE file for the gory details.
 
+## Easy mode
+
+GET request
+```
+  res = Curl.get("https://www.google.com/") {|http|
+    http.timeout = 10 # raise exception if request/response not handled within 10 seconds
+  }
+  puts res.code
+  puts res.head
+  puts res.body
+```
+
+POST request
+```
+  res = Curl.post("https://your-server.com/endpoint", {post: "this"}.to_json) {|http|
+    http.headers["Content-Type"] = "application/json"
+  }
+  puts res.code
+  puts res.head
+  puts res.body
+```
+
+PATCH request
+```
+  res = Curl.patch("https://your-server.com/endpoint", {post: "this"}.to_json) {|http|
+    http.headers["Content-Type"] = "application/json"
+  }
+  puts res.code
+  puts res.head
+  puts res.body
+```
+
+
+
 ## You will need
 
-* A working Ruby installation (2.1+)
-* A working (lib)curl installation, with development stuff (7.5+, tested with 7.19.x)
+* A working Ruby installation (`2.0.0+` will work but `2.1+` preferred) (it's possible it still works with 1.8.7 but you'd have to tell me if not...)
+* 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 |
+| ----------- | -----------  | ---------------- |
+| 1.0.0       | Jan 2022     | 7.58 - 7.81      |
+| 0.9.8       | Jan 2019     | 7.58 - 7.81      |
+| 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:
@@ -27,10 +79,14 @@ Ruby license. See the LICENSE file for the gory details.
     $ gem install curb
 
 On Windows, make sure you're using the [DevKit](http://rubyinstaller.org/downloads/) and
-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
+the [development version of libcurl](http://curl.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/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:
 
@@ -47,6 +103,12 @@ expand on the above instructions, please report the issue at http://github.com/t
 
 On Ubuntu, the dependencies can be satisfied by installing the following packages:
 
+18.04 and onwards
+    
+    $ sudo apt-get install libcurl4 libcurl3-gnutls libcurl4-openssl-dev
+
+< 18.04
+
     $ sudo apt-get install libcurl3 libcurl3-gnutls libcurl4-openssl-dev
 
 On RedHat:

data/Rakefile

@@ -2,6 +2,7 @@
 # 
 require 'rake/clean'
 require 'rake/testtask'
+require "ruby_memcheck"
 
 CLEAN.include '**/*.o'
 CLEAN.include "**/*.#{(defined?(RbConfig) ? RbConfig : Config)::MAKEFILE_CONFIG['DLEXT']}"
@@ -10,13 +11,6 @@ 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}
@@ -57,22 +51,20 @@ 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
-    shell('ruby', 'extconf.rb', ENV['EXTCONF_OPTS'].to_s, live_stdout: STDOUT)
-  end
+  shell(['ruby', 'extconf.rb', ENV['EXTCONF_OPTS'].to_s],
+        { :live_stdout => STDOUT , :cwd => "#{Dir.pwd}/ext" }
+       ).error!
 end
 
 def make(target = '')
-  Dir.chdir('ext') do 
-    pid = system("#{MAKECMD} #{MAKEOPTS} #{target}")
-    $?.exitstatus
-  end    
+  shell(["#{MAKECMD}", "#{MAKEOPTS}", "#{target}"].reject(&:empty?),
+        { :live_stdout => STDOUT, :cwd => "#{Dir.pwd}/ext" }
+       ).error!
 end
 
 # Let make handle dependencies between c/o/so - we'll just run it. 
 file CURB_SO => (['ext/Makefile'] + Dir['ext/*.c'] + Dir['ext/*.h']) do
-  m = make
-  fail "Make failed (status #{m})" unless m == 0
+  make
 end
 
 desc "Compile the shared object"
@@ -80,8 +72,7 @@ task :compile => [CURB_SO]
 
 desc "Install to your site_ruby directory"
 task :install do
-  m = make 'install' 
-  fail "Make install failed (status #{m})" unless m == 0
+  make 'install'
 end
 
 # Test Tasks ---------------------------------------------------------
@@ -100,6 +91,14 @@ else
   task :alltests => [:unittests, :bugtests]
 end
 
+RubyMemcheck.config(binary_name: 'curb_core')
+namespace :test do
+  RubyMemcheck::TestTask.new(valgrind: :compile) do|t|
+    t.test_files = FileList['tests/tc_*.rb']
+    t.verbose = false
+  end
+end
+
 Rake::TestTask.new(:unittests) do |t|
   t.test_files = FileList['tests/tc_*.rb']
   t.verbose = false
@@ -186,7 +185,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

@@ -235,12 +235,16 @@ static VALUE ruby_curl_http2_q(VALUE mod) {
 #endif
 }
 
+static void finalize_curb_core(VALUE data) {
+  curl_global_cleanup();
+}
+
 void Init_curb_core() {
-  // TODO we need to call curl_global_cleanup at exit!
   curl_version_info_data *ver;
   VALUE curlver, curllongver, curlvernum;
 
   curl_global_init(CURL_GLOBAL_ALL);
+  rb_set_end_proc(finalize_curb_core, Qnil);
   ver = curl_version_info(CURLVERSION_NOW);
 
   mCurl = rb_define_module("Curl");
@@ -292,18 +296,26 @@ void Init_curb_core() {
 #endif
 
 #ifdef CURL_VERSION_SSL
-  rb_define_const(mCurl, "CURL_SSLVERSION_DEFAULT", LONG2NUM(CURL_SSLVERSION_DEFAULT));
+  rb_define_const(mCurl, "CURL_SSLVERSION_DEFAULT",     LONG2NUM(CURL_SSLVERSION_DEFAULT));
+  rb_define_const(mCurl, "CURL_SSLVERSION_MAX_DEFAULT", LONG2NUM(CURL_SSLVERSION_MAX_DEFAULT));
   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));
+  rb_define_const(mCurl, "CURL_SSLVERSION_TLSv1_0",     LONG2NUM(CURL_SSLVERSION_TLSv1_0));
+  rb_define_const(mCurl, "CURL_SSLVERSION_MAX_TLSv1_0", LONG2NUM(CURL_SSLVERSION_MAX_TLSv1_0));
 #endif
 #if HAVE_CURL_SSLVERSION_TLSV1_1
-  rb_define_const(mCurl, "CURL_SSLVERSION_TLSv1_1",   LONG2NUM(CURL_SSLVERSION_TLSv1_1));
+  rb_define_const(mCurl, "CURL_SSLVERSION_TLSv1_1",     LONG2NUM(CURL_SSLVERSION_TLSv1_1));
+  rb_define_const(mCurl, "CURL_SSLVERSION_MAX_TLSv1_1", LONG2NUM(CURL_SSLVERSION_MAX_TLSv1_1));
 #endif
 #if HAVE_CURL_SSLVERSION_TLSV1_2
-  rb_define_const(mCurl, "CURL_SSLVERSION_TLSv1_2",   LONG2NUM(CURL_SSLVERSION_TLSv1_2));
+  rb_define_const(mCurl, "CURL_SSLVERSION_TLSv1_2",     LONG2NUM(CURL_SSLVERSION_TLSv1_2));
+  rb_define_const(mCurl, "CURL_SSLVERSION_MAX_TLSv1_2", LONG2NUM(CURL_SSLVERSION_MAX_TLSv1_2));
+#endif
+#if HAVE_CURL_SSLVERSION_TLSV1_3
+  rb_define_const(mCurl, "CURL_SSLVERSION_TLSv1_3",     LONG2NUM(CURL_SSLVERSION_TLSv1_3));
+  rb_define_const(mCurl, "CURL_SSLVERSION_MAX_TLSv1_3", LONG2NUM(CURL_SSLVERSION_MAX_TLSv1_3));
 #endif
 
   rb_define_const(mCurl, "CURL_USESSL_CONTROL", LONG2NUM(CURB_FTPSSL_CONTROL));
@@ -316,13 +328,20 @@ void Init_curb_core() {
   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));
+  rb_define_const(mCurl, "CURL_SSLVERSION_TLSv1_0",     LONG2NUM(-1));
+  rb_define_const(mCurl, "CURL_SSLVERSION_MAX_TLSv1_0", LONG2NUM(-1));
 #endif
 #if HAVE_CURL_SSLVERSION_TLSv1_1
-  rb_define_const(mCurl, "CURL_SSLVERSION_TLSv1_1", LONG2NUM(-1));
+  rb_define_const(mCurl, "CURL_SSLVERSION_TLSv1_1",     LONG2NUM(-1));
+  rb_define_const(mCurl, "CURL_SSLVERSION_MAX_TLSv1_1", LONG2NUM(-1));
 #endif
 #if HAVE_CURL_SSLVERSION_TLSv1_2
-  rb_define_const(mCurl, "CURL_SSLVERSION_TLSv1_2", LONG2NUM(-1));
+  rb_define_const(mCurl, "CURL_SSLVERSION_TLSv1_2",     LONG2NUM(-1));
+  rb_define_const(mCurl, "CURL_SSLVERSION_MAX_TLSv1_2", LONG2NUM(-1));
+#endif
+#if HAVE_CURL_SSLVERSION_TLSv1_3
+  rb_define_const(mCurl, "CURL_SSLVERSION_TLSv1_3",     LONG2NUM(-1));
+  rb_define_const(mCurl, "CURL_SSLVERSION_MAX_TLSv1_3", LONG2NUM(-1));
 #endif
 
   rb_define_const(mCurl, "CURL_USESSL_CONTROL", LONG2NUM(-1));
@@ -925,12 +944,19 @@ void Init_curb_core() {
 #endif
 #if HAVE_CURL_SSLVERSION_TLSv1_0
   CURB_DEFINE(CURL_SSLVERSION_TLSv1_0);
+  CURB_DEFINE(CURL_SSLVERSION_MAX_TLSv1_0);
 #endif
 #if HAVE_CURL_SSLVERSION_TLSv1_1
   CURB_DEFINE(CURL_SSLVERSION_TLSv1_1);
+  CURB_DEFINE(CURL_SSLVERSION_MAX_TLSv1_1);
 #endif
 #if HAVE_CURL_SSLVERSION_TLSv1_2
   CURB_DEFINE(CURL_SSLVERSION_TLSv1_2);
+  CURB_DEFINE(CURL_SSLVERSION_MAX_TLSv1_2);
+#endif
+#if HAVE_CURL_SSLVERSION_TLSv1_3
+  CURB_DEFINE(CURL_SSLVERSION_TLSv1_3);
+  CURB_DEFINE(CURL_SSLVERSION_MAX_TLSv1_3);
 #endif
 #if HAVE_CURLOPT_SSL_VERIFYPEER
   CURB_DEFINE(CURLOPT_SSL_VERIFYPEER);
@@ -1040,6 +1066,136 @@ void Init_curb_core() {
   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 HAVE_CURLOPT_PROXY_SSL_VERIFYHOST
+  CURB_DEFINE(CURLOPT_PROXY_SSL_VERIFYHOST);
+#endif
+
+#if HAVE_CURLPROTO_RTMPTE
+  CURB_DEFINE(CURLPROTO_RTMPTE);
+#endif
+
+#if HAVE_CURLPROTO_RTMPTS
+  CURB_DEFINE(CURLPROTO_RTMPTS);
+#endif
+
+#if HAVE_CURLPROTO_SMBS
+  CURB_DEFINE(CURLPROTO_SMBS);
+#endif
+
+#if HAVE_CURLPROTO_LDAP
+  CURB_DEFINE(CURLPROTO_LDAP);
+#endif
+
+#if HAVE_CURLPROTO_FTP
+  CURB_DEFINE(CURLPROTO_FTP);
+#endif
+
+#if HAVE_CURLPROTO_SMTPS
+  CURB_DEFINE(CURLPROTO_SMTPS);
+#endif
+
+#if HAVE_CURLPROTO_HTTP
+  CURB_DEFINE(CURLPROTO_HTTP);
+#endif
+
+#if HAVE_CURLPROTO_SMTP
+  CURB_DEFINE(CURLPROTO_SMTP);
+#endif
+
+#if HAVE_CURLPROTO_TFTP
+  CURB_DEFINE(CURLPROTO_TFTP);
+#endif
+
+#if HAVE_CURLPROTO_LDAPS
+  CURB_DEFINE(CURLPROTO_LDAPS);
+#endif
+
+#if HAVE_CURLPROTO_IMAPS
+  CURB_DEFINE(CURLPROTO_IMAPS);
+#endif
+
+#if HAVE_CURLPROTO_SCP
+  CURB_DEFINE(CURLPROTO_SCP);
+#endif
+
+#if HAVE_CURLPROTO_SFTP
+  CURB_DEFINE(CURLPROTO_SFTP);
+#endif
+
+#if HAVE_CURLPROTO_TELNET
+  CURB_DEFINE(CURLPROTO_TELNET);
+#endif
+
+#if HAVE_CURLPROTO_FILE
+  CURB_DEFINE(CURLPROTO_FILE);
+#endif
+
+#if HAVE_CURLPROTO_FTPS
+  CURB_DEFINE(CURLPROTO_FTPS);
+#endif
+
+#if HAVE_CURLPROTO_HTTPS
+  CURB_DEFINE(CURLPROTO_HTTPS);
+#endif
+
+#if HAVE_CURLPROTO_IMAP
+  CURB_DEFINE(CURLPROTO_IMAP);
+#endif
+
+#if HAVE_CURLPROTO_POP3
+  CURB_DEFINE(CURLPROTO_POP3);
+#endif
+
+#if HAVE_CURLPROTO_GOPHER
+  CURB_DEFINE(CURLPROTO_GOPHER);
+#endif
+
+#if HAVE_CURLPROTO_DICT
+  CURB_DEFINE(CURLPROTO_DICT);
+#endif
+
+#if HAVE_CURLPROTO_SMB
+  CURB_DEFINE(CURLPROTO_SMB);
+#endif
+
+#if HAVE_CURLPROTO_RTMP
+  CURB_DEFINE(CURLPROTO_RTMP);
+#endif
+
+#if HAVE_CURLPROTO_ALL
+  CURB_DEFINE(CURLPROTO_ALL);
+#endif
+
+#if HAVE_CURLPROTO_RTMPE
+  CURB_DEFINE(CURLPROTO_RTMPE);
+#endif
+
+#if HAVE_CURLPROTO_RTMPS
+  CURB_DEFINE(CURLPROTO_RTMPS);
+#endif
+
+#if HAVE_CURLPROTO_RTMPT
+  CURB_DEFINE(CURLPROTO_RTMPT);
+#endif
+
+#if HAVE_CURLPROTO_POP3S
+  CURB_DEFINE(CURLPROTO_POP3S);
+#endif
+
+#if HAVE_CURLPROTO_RTSP
+  CURB_DEFINE(CURLPROTO_RTSP);
+#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.8"
-#define CURB_VER_NUM   908
-#define CURB_VER_MAJ   0
-#define CURB_VER_MIN   9
-#define CURB_VER_MIC   8
+#define CURB_VERSION   "1.0.5"
+#define CURB_VER_NUM   1005
+#define CURB_VER_MAJ   1
+#define CURB_VER_MIN   0
+#define CURB_VER_MIC   5
 #define CURB_VER_PATCH 0
 
 
@@ -41,6 +49,11 @@
   #define RHASH_SIZE(hash) RHASH(hash)->tbl->num_entries
 #endif
 
+// ruby 1.8 does not provide the macro
+#ifndef DBL2NUM
+  #define DBL2NUM(dbl) rb_float_new(dbl)
+#endif
+
 extern VALUE mCurl;
 
 extern void Init_curb_core();