patron 0.8.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e89c04473c18143c350dcbbbf6f98b1c66b2e7e
-  data.tar.gz: 5a019a6f724c14056f949eb4fafb538454b959c6
+  metadata.gz: f6d71dc0eaded4e48a770c409f82a571a4f77151
+  data.tar.gz: cdf33d99ce93e86f79d7889860be83f2cb87ba94
 SHA512:
-  metadata.gz: 6468281adbd09ad4cbc02eaaa64c36926e108ecd6c9b7a38ffcf8223e5c9930147197c858dac1d30b0f728ece4065f97f32604e07f4016036363b5e110f30ce6
-  data.tar.gz: 897c874cf04b2f3d8fa5e327a5cc78bd86d3ba4a6b27828812c67bc3433cdc0d4c4e6bad266ef655a9349d8f7d711cd95d60bd8c166ede3c8456c788fcc21197
+  metadata.gz: c7d7a4a3832c5b9774cc8171b51e69c15fba9d9d05a050b0ecda76c437ee3db9bb87aad218dfd3f34b54bb34e99612f410e56a0ab21714f5010b3fdb381bbd01
+  data.tar.gz: 72dddcb493902c90deb114655c61a247a7927f2be526c212a8294be5c3a0bb144fd92fb666450a84cd83c249a91f2b105d9508caf87210b432acec5b85ae496f

data/.travis.yml

@@ -3,5 +3,7 @@ rvm:
 - 2.1.5
 - 2.2.2
 - 2.3.0
+- 2.4.1
 sudo: false
+dist: trusty
 cache: bundler

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+### 0.9.1
+
+* Added ssl_version options `TLSv1_1`, `TLSv1_2`, `TLSv1_3` for explicitly forcing the SSL version
+    * requires the appropriate versions of libCURL and OpenSSL installed to support these new options 
+    * reference: https://curl.haxx.se/libcurl/c/CURLOPT_SSLVERSION.html
+* Added a new `:http_version` option with `HTTPv1_1` and `HTTPv2_0` values to explicitly set the HTTP version of HTTP/1.1 or HTTP/2.0
+    * requires the appropriate versions of libCURL and OpenSSL installed to support these new options 
+    * reference: https://curl.haxx.se/libcurl/c/CURLOPT_HTTP_VERSION.html
+* Updates the gem release procedure for more convenience, using the updated Rubygems.org tasks
+* Update a few minor dependencies and documentation to be Ruby 2.4.1-compatible, add 2.4.1. to Travis CI matrix
+* Add `Session#download_byte_limit` for limiting the permitted download size.
+  This can be very useful in dealing with untrusted download sources, which might attempt
+  to send very large responses that would overwhelm the receiving client.
+* Add `Patron.libcurl_version_exact` which returns a triplet of major, minor and patch libCURL version numbers. This can be used
+  for more fine-grained matching when using some more esoteric Curl features which might not necessarily be available on libCURL
+  Patron has been linked against.
+
 ### 0.8.0
 
 * Add `Response#inspectable_body`, `Response#decoded_body`. `decoded_body` will atempt to decode

data/Gemfile

@@ -1,2 +1,4 @@
 source 'https://rubygems.org'
+
+# Specify your gem's dependencies in patron.gemspec
 gemspec

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    patron (0.8.0)
+    patron (0.9.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.2.5)
     docile (1.1.5)
-    json (1.8.3)
+    json (2.1.0)
     rake (10.4.2)
     rake-compiler (0.9.5)
       rake
@@ -25,23 +25,24 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.3.0)
     rspec-support (3.3.0)
-    simplecov (0.10.0)
+    simplecov (0.14.1)
       docile (~> 1.1.0)
-      json (~> 1.8)
+      json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
+    simplecov-html (0.10.1)
     yard (0.8.7.6)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (>= 1.0.0)
+  bundler (>= 1)
   patron!
-  rake-compiler (>= 0.7.5)
+  rake (~> 10)
+  rake-compiler
   rspec (>= 2.3.0)
-  simplecov (>= 0.10.0)
+  simplecov (~> 0.10)
   yard (~> 0.8)
 
 BUNDLED WITH
-   1.11.2
+   1.14.6

data/Rakefile

@@ -24,17 +24,17 @@
 require 'rake/clean'
 require 'rake/extensiontask'
 require 'rspec/core/rake_task'
-require 'bundler'
+require "bundler/gem_tasks"
 require 'yard'
 
+RSpec::Core::RakeTask.new(:spec)
+
 Rake::ExtensionTask.new do |ext|
   ext.name = 'session_ext'           # indicate the name of the extension.
   ext.ext_dir = 'ext/patron'         # search for 'hello_world' inside it.
   ext.lib_dir = 'lib/patron'         # put binaries into this folder.
 end
 
-Bundler::GemHelper.install_tasks
-
 CLEAN.include FileList["ext/patron/*"].exclude(/^.*\.(rb|c|h)$/)
 CLOBBER.include %w( doc coverage pkg )
 
@@ -50,12 +50,5 @@ YARD::Rake::YardocTask.new do |t|
   t.stats_options = ['--list-undoc']
 end
 
-desc "Run specs"
-RSpec::Core::RakeTask.new do |t|
-  t.rspec_opts = %w( --colour --format progress )
-  t.pattern = 'spec/**/*_spec.rb'
-end
-
-task :spec => [:compile]
-
-task :default => :spec
+task :default => [:clobber, :compile, :spec]
+task :build => [:clobber] # Make sure no binaries end up in the gem

data/ext/patron/session_ext.c

@@ -32,6 +32,8 @@
 #include "sglib.h"  /* Simple Generic Library -> http://sglib.sourceforge.net */
 
 #define UNUSED_ARGUMENT(x) (void)x
+#define INTERRUPT_ABORT 1
+#define INTERRUPT_DOWNLOAD_OVERFLOW 2
 
 static VALUE mPatron = Qnil;
 static VALUE mProxyType = Qnil;
@@ -40,15 +42,16 @@ static VALUE cRequest = Qnil;
 static VALUE ePatronError = Qnil;
 static VALUE eUnsupportedProtocol = Qnil;
 static VALUE eUnsupportedSSLVersion = Qnil;
+static VALUE eUnsupportedHTTPVersion = Qnil;
 static VALUE eURLFormatError = Qnil;
 static VALUE eHostResolutionError = Qnil;
 static VALUE eConnectionFailed = Qnil;
 static VALUE ePartialFileError = Qnil;
 static VALUE eTimeoutError = Qnil;
 static VALUE eTooManyRedirects = Qnil;
+static VALUE eAborted = Qnil;
 
-
-struct curl_state {
+struct patron_curl_state {
   CURL* handle;
   char* upload_buf;
   FILE* download_file;
@@ -60,6 +63,7 @@ struct curl_state {
   struct curl_httppost* last;
   membuffer header_buffer;
   membuffer body_buffer;
+  size_t download_byte_limit;
   int interrupt;
 };
 
@@ -78,17 +82,39 @@ static size_t session_write_handler(char* stream, size_t size, size_t nmemb, mem
   return size * nmemb;
 }
 
+/* Used as WRITEFUNCTION for file downloads (required on Windows) */
+static size_t file_write_handler(void* stream, size_t size, size_t nmemb, FILE* fp) {
+  fwrite(stream, size, nmemb, fp);
+  if (ferror(fp)) {
+    return 0;
+  } else {
+    /* Just always OK the write */
+    return size * nmemb;
+  }
+}
+
 /* A non-zero return value from the progress handler will terminate the current
  * request. We use this fact in order to interrupt any request when either the
  * user calls the "interrupt" method on the session or when the Ruby interpreter
  * is attempting to exit.
  */
-static int session_progress_handler(void *clientp, double dltotal, double dlnow, double ultotal, double ulnow) {
-  struct curl_state* state = (struct curl_state*) clientp;
-  UNUSED_ARGUMENT(dltotal);
+static int session_progress_handler(void *clientp, size_t dltotal, size_t dlnow, size_t ultotal, size_t ulnow) {
+  struct patron_curl_state* state = (struct patron_curl_state*) clientp;
   UNUSED_ARGUMENT(dlnow);
   UNUSED_ARGUMENT(ultotal);
   UNUSED_ARGUMENT(ulnow);
+
+  // Set the interrupt if the download byte limit has been reached
+  if(state->download_byte_limit != 0 && (dltotal > state->download_byte_limit)) {
+    state->interrupt = INTERRUPT_DOWNLOAD_OVERFLOW;
+  }
+  
+  // If the interrupt value is anything except 0, the perform() call
+  // will be aborted by libCURL.
+  // Note however that some older versions of libcurl have a bug which
+  // makes the return value of this callback be ignored, and the request
+  // will actually proceed undeterred.
+  // See https://sourceforge.net/p/curl/bugs/1318/
   return state->interrupt;
 }
 
@@ -96,32 +122,32 @@ static int session_progress_handler(void *clientp, double dltotal, double dlnow,
 /*----------------------------------------------------------------------------*/
 /* List of active curl sessions                                               */
 
-struct curl_state_list {
-  struct curl_state       *state;
-  struct curl_state_list  *next;
+struct patron_curl_state_list {
+  struct patron_curl_state       *state;
+  struct patron_curl_state_list  *next;
 };
 
 #define CS_LIST_COMPARATOR(p, _state_) (p->state - _state_)
 
-static struct curl_state_list *cs_list = NULL;
+static struct patron_curl_state_list *cs_list = NULL;
 
-static void cs_list_append( struct curl_state *state ) {
-  struct curl_state_list *item = NULL;
+static void cs_list_append( struct patron_curl_state *state ) {
+  struct patron_curl_state_list *item = NULL;
 
   assert(state != NULL);
-  item = ruby_xmalloc(sizeof(struct curl_state_list));
+  item = ruby_xmalloc(sizeof(struct patron_curl_state_list));
   item->state = state;
   item->next = NULL;
 
-  SGLIB_LIST_ADD(struct curl_state_list, cs_list, item, next);
+  SGLIB_LIST_ADD(struct patron_curl_state_list, cs_list, item, next);
 }
 
-static void cs_list_remove(struct curl_state *state) {
-  struct curl_state_list *item = NULL;
+static void cs_list_remove(struct patron_curl_state *state) {
+  struct patron_curl_state_list *item = NULL;
 
   assert(state != NULL);
 
-  SGLIB_LIST_DELETE_IF_MEMBER(struct curl_state_list, cs_list, state, CS_LIST_COMPARATOR, next, item);
+  SGLIB_LIST_DELETE_IF_MEMBER(struct patron_curl_state_list, cs_list, state, CS_LIST_COMPARATOR, next, item);
   if (item) {
     ruby_xfree(item);
   }
@@ -130,8 +156,8 @@ static void cs_list_remove(struct curl_state *state) {
 static void cs_list_interrupt(VALUE data) {
   UNUSED_ARGUMENT(data);
 
-  SGLIB_LIST_MAP_ON_ELEMENTS(struct curl_state_list, cs_list, item, next, {
-    item->state->interrupt = 1;
+  SGLIB_LIST_MAP_ON_ELEMENTS(struct patron_curl_state_list, cs_list, item, next, {
+    item->state->interrupt = INTERRUPT_ABORT;
   });
 }
 
@@ -139,7 +165,7 @@ static void cs_list_interrupt(VALUE data) {
 /*----------------------------------------------------------------------------*/
 /* Object allocation                                                          */
 
-static void session_close_debug_file(struct curl_state *curl) {
+static void session_close_debug_file(struct patron_curl_state *curl) {
   if (curl->debug_file && stderr != curl->debug_file) {
     fclose(curl->debug_file);
   }
@@ -147,7 +173,7 @@ static void session_close_debug_file(struct curl_state *curl) {
 }
 
 /* Cleans up the Curl handle when the Session object is garbage collected. */
-void session_free(struct curl_state *curl) {
+void session_free(struct patron_curl_state *curl) {
   if (curl->handle) {
     curl_easy_cleanup(curl->handle);
     curl->handle = NULL;
@@ -163,10 +189,10 @@ void session_free(struct curl_state *curl) {
   free(curl);
 }
 
-/* Allocates curl_state data needed for a new Session object. */
+/* Allocates patron_curl_state data needed for a new Session object. */
 VALUE session_alloc(VALUE klass) {
-  struct curl_state* curl;
-  VALUE obj = Data_Make_Struct(klass, struct curl_state, NULL, session_free, curl);
+  struct patron_curl_state* curl;
+  VALUE obj = Data_Make_Struct(klass, struct patron_curl_state, NULL, session_free, curl);
 
   membuffer_init( &curl->header_buffer );
   membuffer_init( &curl->body_buffer );
@@ -175,16 +201,22 @@ VALUE session_alloc(VALUE klass) {
   return obj;
 }
 
-/* Return the curl_state from the ruby VALUE which is the Session instance. */
-static struct curl_state* get_curl_state(VALUE self) {
-  struct curl_state *state;
-  Data_Get_Struct(self, struct curl_state, state);
+/* Return the patron_curl_state from the ruby VALUE which is the Session instance. */
+static struct patron_curl_state* get_patron_curl_state(VALUE self) {
+  struct patron_curl_state* state;
+  Data_Get_Struct(self, struct patron_curl_state, state);
 
   if (NULL == state->handle) {
     state->handle = curl_easy_init();
     curl_easy_setopt(state->handle, CURLOPT_NOSIGNAL, 1);
     curl_easy_setopt(state->handle, CURLOPT_NOPROGRESS, 0);
-    curl_easy_setopt(state->handle, CURLOPT_PROGRESSFUNCTION, &session_progress_handler);
+    #if LIBCURL_VERSION_NUM >= 0x072000
+      /* this is libCURLv7.32.0 or later, supports CURLOPT_XFERINFOFUNCTION */
+      curl_easy_setopt(state->handle, CURLOPT_XFERINFOFUNCTION, &session_progress_handler);
+    #else
+      curl_easy_setopt(state->handle, CURLOPT_PROGRESSFUNCTION, &session_progress_handler);
+    #endif
+
     curl_easy_setopt(state->handle, CURLOPT_PROGRESSDATA, state);
   }
 
@@ -206,6 +238,20 @@ static VALUE libcurl_version(VALUE klass) {
   return rb_str_new2(value);
 }
 
+/*
+* Returns the version of the embedded libcurl.
+* 
+*  @return [Array] an array of MAJOR, MINOR, PATCH integers
+ */
+static VALUE libcurl_version_exact(VALUE klass) {
+  UNUSED_ARGUMENT(klass);
+  VALUE cv_major = INT2FIX(LIBCURL_VERSION_MAJOR);
+  VALUE cv_minor = INT2FIX(LIBCURL_VERSION_MINOR);
+  VALUE cv_patch = INT2FIX(LIBCURL_VERSION_PATCH);
+  VALUE version_arr = rb_ary_new3(3, cv_major, cv_minor, cv_patch);
+  return version_arr;
+}
+
 /*
  * Escapes the provided string using libCURL URL escaping functions.
  *
@@ -218,7 +264,7 @@ static VALUE session_escape(VALUE self, VALUE value) {
   char* escaped = NULL;
   VALUE retval = Qnil;
 
-  struct curl_state* state = curl_easy_init();
+  struct patron_curl_state* state = curl_easy_init();
   escaped = curl_easy_escape(state->handle,
                              RSTRING_PTR(string),
                              (int) RSTRING_LEN(string));
@@ -241,7 +287,7 @@ static VALUE session_unescape(VALUE self, VALUE value) {
   char* unescaped = NULL;
   VALUE retval = Qnil;
 
-  struct curl_state* state = curl_easy_init();
+  struct patron_curl_state* state = curl_easy_init();
   unescaped = curl_easy_unescape(state->handle,
                                  RSTRING_PTR(string),
                                  (int) RSTRING_LEN(string),
@@ -256,7 +302,7 @@ static VALUE session_unescape(VALUE self, VALUE value) {
 
 /* Callback used to iterate over the HTTP headers and store them in an slist. */
 static int each_http_header(VALUE header_key, VALUE header_value, VALUE self) {
-  struct curl_state *state = get_curl_state(self);
+  struct patron_curl_state *state = get_patron_curl_state(self);
   CURL* curl = state->handle;
 
   VALUE name = rb_obj_as_string(header_key);
@@ -286,7 +332,7 @@ static int each_http_header(VALUE header_key, VALUE header_value, VALUE self) {
 }
 
 static int formadd_values(VALUE data_key, VALUE data_value, VALUE self) {
-  struct curl_state *state = get_curl_state(self);
+  struct patron_curl_state *state = get_patron_curl_state(self);
   VALUE name = rb_obj_as_string(data_key);
   VALUE value = rb_obj_as_string(data_value);
 
@@ -297,7 +343,7 @@ static int formadd_values(VALUE data_key, VALUE data_value, VALUE self) {
 }
 
 static int formadd_files(VALUE data_key, VALUE data_value, VALUE self) {
-  struct curl_state *state = get_curl_state(self);
+  struct patron_curl_state *state = get_patron_curl_state(self);
   VALUE name = rb_obj_as_string(data_key);
   VALUE value = rb_obj_as_string(data_value);
 
@@ -317,7 +363,7 @@ static void set_curl_request_body(CURL* curl, char* buf, curl_off_t len) {
   #endif
 }
 
-static void set_chunked_encoding(struct curl_state *state) {
+static void set_chunked_encoding(struct patron_curl_state *state) {
   state->headers = curl_slist_append(state->headers, "Transfer-Encoding: chunked");
 }
 
@@ -330,7 +376,7 @@ static FILE* open_file(VALUE filename, const char* perms) {
   return handle;
 }
 
-static void set_request_body_file(struct curl_state* state, VALUE r_path_str) {
+static void set_request_body_file(struct patron_curl_state* state, VALUE r_path_str) {
   CURL* curl = state->handle;
   
   state->request_body_file = open_file(r_path_str, "rb");
@@ -345,7 +391,7 @@ static void set_request_body_file(struct curl_state* state, VALUE r_path_str) {
   #endif
 }
 
-static void set_request_body(struct curl_state* state, VALUE stringable_or_file) {
+static void set_request_body(struct patron_curl_state* state, VALUE stringable_or_file) {
   CURL* curl = state->handle;
   if(rb_respond_to(stringable_or_file, rb_intern("to_path"))) {
     // Set up a file read callback (read the entire request body from a file).
@@ -368,7 +414,7 @@ static void set_request_body(struct curl_state* state, VALUE stringable_or_file)
  * handle.
  */
 static void set_options_from_request(VALUE self, VALUE request) {
-  struct curl_state* state = get_curl_state(self);
+  struct patron_curl_state* state = get_patron_curl_state(self);
   CURL* curl = state->handle;
 
   ID    action                = Qnil;
@@ -383,16 +429,23 @@ static void set_options_from_request(VALUE self, VALUE request) {
   VALUE insecure              = Qnil;
   VALUE cacert                = Qnil;
   VALUE ssl_version           = Qnil;
+  VALUE http_version          = Qnil;
   VALUE buffer_size           = Qnil;
   VALUE action_name           = rb_funcall(request, rb_intern("action"), 0);
   VALUE a_c_encoding          = rb_funcall(request, rb_intern("automatic_content_encoding"), 0);
+  VALUE download_byte_limit   = rb_funcall(request, rb_intern("download_byte_limit"), 0);
+
+  if (RTEST(download_byte_limit)) {
+    state->download_byte_limit = FIX2INT(download_byte_limit);
+  } else {
+    state->download_byte_limit = 0;
+  }
 
   headers = rb_funcall(request, rb_intern("headers"), 0);
   if (RTEST(headers)) {
     if (rb_type(headers) != T_HASH) {
       rb_raise(rb_eArgError, "Headers must be passed in a hash.");
     }
-
     rb_hash_foreach(headers, each_http_header, self);
   }
 
@@ -410,8 +463,12 @@ static void set_options_from_request(VALUE self, VALUE request) {
       curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "GET");
     }
     if (RTEST(download_file)) {
+      // we need the WRITEDATA option for the file destination
       state->download_file = open_file(download_file, "wb");
       curl_easy_setopt(curl, CURLOPT_WRITEDATA, state->download_file);
+      // curl docs say that CURLOPT_WRITEFUNCTION must be set too
+      // to avoid issues on Windows
+      curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, &file_write_handler);
     } else {
       state->download_file = NULL;
     }
@@ -553,17 +610,69 @@ static void set_options_from_request(VALUE self, VALUE request) {
   if(RTEST(ssl_version)) {
     VALUE ssl_version_str = rb_funcall(ssl_version, rb_intern("to_s"), 0);
     char* version = StringValuePtr(ssl_version_str);
+
     if(strcmp(version, "SSLv2") == 0) {
       curl_easy_setopt(curl, CURLOPT_SSLVERSION, CURL_SSLVERSION_SSLv2);
     } else if(strcmp(version, "SSLv3") == 0) {
       curl_easy_setopt(curl, CURLOPT_SSLVERSION, CURL_SSLVERSION_SSLv3);
     } else if(strcmp(version, "TLSv1") == 0) {
-      curl_easy_setopt(curl, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);
-    } else {
+          curl_easy_setopt(curl, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1);
+    }
+    #if LIBCURL_VERSION_NUM >= 0x072200
+    /* this is libCURLv7.34.0 or later */
+    else if(strcmp(version, "TLSv1_0") == 0) {
+      curl_easy_setopt(curl, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1_0); //libcurl v7.34.0+
+    } else if(strcmp(version, "TLSv1_1") == 0) {
+      curl_easy_setopt(curl, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1_1); //libcurl v7.34.0+
+    } else if(strcmp(version, "TLSv1_2") == 0) {
+      curl_easy_setopt(curl, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1_2); //libcurl v7.34.0+
+    }
+    #endif
+    #if LIBCURL_VERSION_NUM >= 0x073400
+    /* this is libCURLv7.52.0 or later */
+    else if(strcmp(version, "TLSv1_3") == 0) {
+      curl_easy_setopt(curl, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1_3); //libcurl v7.52.0+
+    }
+    #endif
+    else {
       rb_raise(eUnsupportedSSLVersion, "Unsupported SSL version: %s", version);
     }
   }
 
+  http_version = rb_funcall(request, rb_intern("http_version"), 0);
+  if(RTEST(http_version)) {
+    VALUE http_version_str = rb_funcall(http_version, rb_intern("to_s"), 0);
+    char* version = StringValuePtr(http_version_str);
+    if(strcmp(version, "None") == 0) {
+      curl_easy_setopt(curl, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_NONE);
+    } else if(strcmp(version, "HTTPv1_0") == 0) {
+      curl_easy_setopt(curl, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);
+    } else if(strcmp(version, "HTTPv1_1") == 0) {
+          curl_easy_setopt(curl, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);
+    }
+    #if LIBCURL_VERSION_NUM >= 0x072100
+    /* this is libCURLv7.33.0 or later */
+    else if(strcmp(version, "HTTPv2_0") == 0) {
+      curl_easy_setopt(curl, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_2_0); //libcurl v7.33.0+
+    }
+    #endif
+    #if LIBCURL_VERSION_NUM >= 0x072F00
+    /* this is libCURLv7.47.0 or later */
+    else if(strcmp(version, "HTTPv2_TLS") == 0) {
+      curl_easy_setopt(curl, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_2TLS); //libcurl v7.47.0+
+    }
+    #endif
+    #if LIBCURL_VERSION_NUM >= 0x073100
+    /* this is libCURLv7.49.0 or later */
+    else if(strcmp(version, "HTTPv2_PRIOR") == 0) {
+      curl_easy_setopt(curl, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_2_PRIOR_KNOWLEDGE); //libcurl v7.49.0+
+    }
+    #endif
+    else {
+      rb_raise(eUnsupportedHTTPVersion, "Unsupported HTTP version: %s", version);
+    }
+  }
+
   cacert = rb_funcall(request, rb_intern("cacert"), 0);
   if(RTEST(cacert)) {
     curl_easy_setopt(curl, CURLOPT_CAINFO, StringValuePtr(cacert));
@@ -616,7 +725,7 @@ static VALUE select_error(CURLcode code) {
     case CURLE_PARTIAL_FILE:          error = ePartialFileError;    break;
     case CURLE_OPERATION_TIMEDOUT:    error = eTimeoutError;        break;
     case CURLE_TOO_MANY_REDIRECTS:    error = eTooManyRedirects;    break;
-
+    case CURLE_ABORTED_BY_CALLBACK:   error = eAborted;             break;
     default: error = ePatronError;
   }
 
@@ -625,13 +734,13 @@ static VALUE select_error(CURLcode code) {
 
 /* Perform the actual HTTP request by calling libcurl. */
 static VALUE perform_request(VALUE self) {
-  struct curl_state *state = get_curl_state(self);
+  struct patron_curl_state *state = get_patron_curl_state(self);
   CURL* curl = state->handle;
   membuffer* header_buffer = NULL;
   membuffer* body_buffer = NULL;
   CURLcode ret = 0;
 
-  state->interrupt = 0;  /* clear any interrupt flags */
+  state->interrupt = 0;            /* clear the interrupt flag */
 
   header_buffer = &state->header_buffer;
   body_buffer = &state->body_buffer;
@@ -682,7 +791,7 @@ static VALUE perform_request(VALUE self) {
  * all request related objects such as the header slist.
  */
 static VALUE cleanup(VALUE self) {
-  struct curl_state *state = get_curl_state(self);
+  struct patron_curl_state *state = get_patron_curl_state(self);
   curl_easy_reset(state->handle);
 
   if (state->headers) {
@@ -741,8 +850,8 @@ static VALUE session_handle_request(VALUE self, VALUE request) {
  * @return self
  */
 static VALUE session_reset(VALUE self) {
-  struct curl_state *state;
-  Data_Get_Struct(self, struct curl_state, state);
+  struct patron_curl_state *state;
+  Data_Get_Struct(self, struct patron_curl_state, state);
 
   if (NULL != state->handle) {
     cleanup(self);
@@ -760,8 +869,8 @@ static VALUE session_reset(VALUE self) {
  * @return [void] This method always raises
  */
 static VALUE session_interrupt(VALUE self) {
-  struct curl_state *state = get_curl_state(self);
-  state->interrupt = 1;
+  struct patron_curl_state *state = get_patron_curl_state(self);
+  state->interrupt = INTERRUPT_ABORT;
   return self;
 }
 
@@ -775,7 +884,7 @@ static VALUE session_interrupt(VALUE self) {
 *  @return self
  */
 static VALUE add_cookie_file(VALUE self, VALUE file) {
-  struct curl_state *state = get_curl_state(self);
+  struct patron_curl_state *state = get_patron_curl_state(self);
   CURL* curl = state->handle;
   char* file_path = NULL;
 
@@ -796,7 +905,7 @@ static VALUE add_cookie_file(VALUE self, VALUE file) {
 *  @return self
  */
 static VALUE set_debug_file(VALUE self, VALUE file) {
-  struct curl_state *state = get_curl_state(self);
+  struct patron_curl_state *state = get_patron_curl_state(self);
   char* file_path = RSTRING_PTR(file);
 
   session_close_debug_file(state);
@@ -826,14 +935,17 @@ void Init_session_ext() {
 
   eUnsupportedProtocol = rb_const_get(mPatron, rb_intern("UnsupportedProtocol"));
   eUnsupportedSSLVersion = rb_const_get(mPatron, rb_intern("UnsupportedSSLVersion"));
+  eUnsupportedHTTPVersion = rb_const_get(mPatron, rb_intern("UnsupportedHTTPVersion"));
   eURLFormatError = rb_const_get(mPatron, rb_intern("URLFormatError"));
   eHostResolutionError = rb_const_get(mPatron, rb_intern("HostResolutionError"));
   eConnectionFailed = rb_const_get(mPatron, rb_intern("ConnectionFailed"));
   ePartialFileError = rb_const_get(mPatron, rb_intern("PartialFileError"));
   eTimeoutError = rb_const_get(mPatron, rb_intern("TimeoutError"));
   eTooManyRedirects = rb_const_get(mPatron, rb_intern("TooManyRedirects"));
+  eAborted = rb_const_get(mPatron, rb_intern("Aborted"));
 
-  rb_define_module_function(mPatron, "libcurl_version", libcurl_version, 0);
+  rb_define_module_function(mPatron, "libcurl_version",       libcurl_version, 0);
+  rb_define_module_function(mPatron, "libcurl_version_exact", libcurl_version_exact, 0);
 
   cSession = rb_define_class_under(mPatron, "Session", rb_cObject);
   cRequest = rb_define_class_under(mPatron, "Request", rb_cObject);

data/lib/patron/error.rb

@@ -36,6 +36,9 @@ module Patron
   # Gets raised when a request is attempted with an unsupported SSL version.
   class UnsupportedSSLVersion  < Error; end
 
+  # Gets raised when a request is attempted with an unsupported HTTP version.
+  class UnsupportedHTTPVersion  < Error; end
+
   # Gets raised when the URL was not properly formatted.
   class URLFormatError         < Error; end
 
@@ -56,6 +59,9 @@ module Patron
   # Gets raised on too many redirects. When following redirects, Patron hit the maximum amount.
   class TooManyRedirects       < Error; end
 
+  # Gets raised if the progress callback, or an interrupt, aborts the Curl perform() call
+  class Aborted                < Error; end
+
   # Gets raised when the server specifies an encoding that could not be found, or has an invalid name,
   # or when the server "lies" about the encoding of the response body (such as can be the case
   # when the server specifies an encoding in `Content-Type`) which the HTML generator then overrides

data/lib/patron/request.rb

@@ -50,12 +50,12 @@ module Patron
       :url, :username, :password, :file_name, :proxy, :proxy_type, :insecure,
       :ignore_content_length, :multipart, :action, :timeout, :connect_timeout,
       :max_redirects, :headers, :auth_type, :upload_data, :buffer_size, :cacert,
-      :ssl_version, :automatic_content_encoding, :force_ipv4
+      :ssl_version, :http_version, :automatic_content_encoding, :force_ipv4, :download_byte_limit
     ]
 
     WRITER_VARS = [
       :url, :username, :password, :file_name, :proxy, :proxy_type, :insecure,
-      :ignore_content_length, :multipart, :cacert, :ssl_version, :automatic_content_encoding, :force_ipv4
+      :ignore_content_length, :multipart, :cacert, :ssl_version, :http_version, :automatic_content_encoding, :force_ipv4, :download_byte_limit
     ]
 
     attr_reader *READER_VARS

data/lib/patron/response.rb

@@ -33,13 +33,13 @@ module Patron
     # @return [String] the original URL used to perform the request (contains the final URL after redirects)
     attr_reader :url
 
-    # @return [Fixnum] the HTTP status code of the final response after all the redirects
+    # @return [Integer] the HTTP status code of the final response after all the redirects
     attr_reader :status
 
     # @return [String] the complete status line (code and message)
     attr_reader :status_line
 
-    # @return [Fixnum] how many redirects were followed when fulfilling this request
+    # @return [Integer] how many redirects were followed when fulfilling this request
     attr_reader :redirect_count
 
     # @return [String, nil] the response body as a String encoded as `Encoding::BINARY` or

data/lib/patron/session.rb

@@ -82,6 +82,10 @@ module Patron
     # The supported values are nil, "SSLv2", "SSLv3", and "TLSv1".
     attr_accessor :ssl_version
 
+    # @return [String] the HTTP version for the requests, or "None" if libcurl is to choose permitted versions
+    # The supported values are "None", "HTTPv1_0", "HTTPv1_1", "HTTPv2_0", "HTTPv2_TLS", and "HTTPv2_PRIOR".
+    attr_accessor :http_version
+
     # @return [String] path to the CA file used for certificate verification, or `nil` if CURL default is used
     attr_accessor :cacert
 
@@ -105,7 +109,12 @@ module Patron
 
     # @return [Boolean] Support automatic Content-Encoding decompression and set liberal Accept-Encoding headers
     attr_accessor :automatic_content_encoding
-    
+
+    # @return [Fixnum, nil] Limit the amount of bytes downloaded. If it is set to nil
+    #    (default) no limit will be applied.
+    #    **Note that this only works on libCURL 7.34 and newer**
+    attr_accessor :download_byte_limit
+
     private :handle_request, :add_cookie_file, :set_debug_file
 
     # Create a new Session object for performing requests.
@@ -371,9 +380,11 @@ module Patron
         req.auth_type              = options.fetch :auth_type,             self.auth_type
         req.insecure               = options.fetch :insecure,              self.insecure
         req.ssl_version            = options.fetch :ssl_version,           self.ssl_version
+        req.http_version           = options.fetch :http_version,          self.http_version
         req.cacert                 = options.fetch :cacert,                self.cacert
         req.ignore_content_length  = options.fetch :ignore_content_length, self.ignore_content_length
         req.buffer_size            = options.fetch :buffer_size,           self.buffer_size
+        req.download_byte_limit    = options.fetch :download_byte_limit,   self.download_byte_limit
         req.multipart              = options[:multipart]
         req.upload_data            = options[:data]
         req.file_name              = options[:file]

data/lib/patron/version.rb

@@ -1,3 +1,3 @@
 module Patron
-  VERSION = "0.8.0"
+  VERSION = "0.9.1"
 end

data/patron.gemspec

@@ -1,33 +1,44 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path("../lib/patron/version", __FILE__)
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'patron/version'
 
-Gem::Specification.new do |s|
-  s.name        = "patron"
-  s.version     = Patron::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Phillip Toland"]
-  s.email       = ["phil.toland@gmail.com"]
-  s.homepage    = "https://github.com/toland/patron"
-  s.summary     = "Patron HTTP Client"
-  s.description = "Ruby HTTP client library based on libcurl"
+Gem::Specification.new do |spec|
+  spec.name        = "patron"
+  spec.version     = Patron::VERSION
+  spec.platform    = Gem::Platform::RUBY
+  spec.authors     = ["Phillip Toland"]
+  spec.email       = ["phil.toland@gmail.com"]
+  spec.homepage    = "https://github.com/toland/patron"
+  spec.summary     = "Patron HTTP Client"
+  spec.description = "Ruby HTTP client library based on libcurl"
 
-  s.required_rubygems_version = ">= 1.2.0"
-  s.rubyforge_project = "patron"
+  # Prevent pushing this gem to RubyGemspec.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushespec."
+  end
+  
+  spec.required_rubygems_version = ">= 1.2.0"
+  spec.rubyforge_project = "patron"
 
-  s.add_development_dependency "bundler", ">= 1.0.0"
-  s.add_development_dependency "rake-compiler", ">= 0.7.5"
-  s.add_development_dependency "rspec", ">= 2.3.0"
-  s.add_development_dependency "simplecov", ">= 0.10.0"
-  s.add_development_dependency "yard", "~> 0.8"
-
-  s.files        = `git ls-files`.split("\n")
-  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
-  s.require_paths = ["lib", "ext"]
-  s.extensions   = ["ext/patron/extconf.rb"]
-  s.post_install_message = %q{
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib", "ext"]
+  spec.extensions   = ["ext/patron/extconf.rb"]
+  spec.post_install_message = %q{
 Thank you for installing Patron. On OSX, make sure you are using libCURL with OpenSSL.
-SecureTransport-based builds might cause crashes in forking environments.
+SecureTransport-based builds might cause crashes in forking environment.
 
 For more info see https://github.com/curl/curl/issues/788
 }
+  spec.add_development_dependency "rake", "~> 10"
+  spec.add_development_dependency "bundler", ">= 1"
+  spec.add_development_dependency "rspec", ">= 2.3.0"
+  spec.add_development_dependency "simplecov", "~> 0.10"
+  spec.add_development_dependency "yard", "~> 0.8"
+  spec.add_development_dependency "rake-compiler"
 end

data/spec/patron_spec.rb

@@ -38,9 +38,16 @@ describe Patron do
     expect(version).to match(%r|^\d+.\d+.\d+$|)
   end
 
-  it "should return the version number of the libcurl library" do
+  it "should return the version string of the libcurl library" do
     version = Patron.libcurl_version
     expect(version).to match(%r|^libcurl/\d+.\d+.\d+|)
   end
 
+  it "should return the version numbers of the libcurl library" do
+    version = Patron.libcurl_version_exact
+    expect(version.length).to eq(3)
+    expect(version[0]).to be > 0
+    expect(version[1]).to be >= 0
+    expect(version[2]).to be >= 0
+  end
 end

data/spec/response_spec.rb

@@ -45,7 +45,7 @@ describe Patron::Response do
 
   it 'recovers the status code' do
     response = @session.get("/repetitiveheader")
-    expect(response.status).to be_kind_of(Fixnum)
+    expect(response.status).to be_kind_of(Integer)
     expect(response.status).to eq(200)
   end
   

data/spec/session_spec.rb

@@ -129,6 +129,34 @@ describe Patron::Session do
     FileUtils.rm tmpfile
   end
 
+  it "downloads a very large file" do
+    tmpfile = "/tmp/large-succeeded"
+    @session.get_file "/very-large", tmpfile
+    expect(File.size(tmpfile)).to eq(15 * 1024 * 1024)
+  end
+
+  it "raises an exception if the download body limit is exceeded when using direct-to-file download" do
+    tmpfile = "/tmp/large-aborted"
+    @session.download_byte_limit = 1024
+    @session.buffer_size = 1024
+    expect {
+      @session.get_file "/very-large", tmpfile
+    }.to raise_error(Patron::Error)
+    # On Ruby 2.x Patron::Aborted takes precedence, but
+    # on 1.9 it will be Patron::PartialFileError
+    expect(File.size(tmpfile)).to be < (1024 * 3)
+  end
+
+  it "raises an exception if the download body limit is exceeded when using download-to-memory" do
+    @session.download_byte_limit = 1024
+    @session.buffer_size = 1024
+    expect {
+      @session.get "/very-large"
+    }.to raise_error(Patron::Error)
+    # On Ruby 2.x Patron::Aborted takes precedence, but
+    # on 1.9 it will be Patron::PartialFileError
+  end
+
   it "should not send the user-agent if it has been deleted from headers" do
     @session.headers.delete 'User-Agent'
     response = @session.get("/test")

data/spec/session_ssl_spec.rb

@@ -284,7 +284,7 @@ describe Patron::Session do
   end
 
   it "should work with different SSL versions" do
-    ['SSLv3', 'TLSv1'].each do |version|
+    ['SSLv3','TLSv1'].each do |version|
       @session.ssl_version = version
       response = @session.get("/test")
       expect(response.status).to be == 200
@@ -299,7 +299,24 @@ describe Patron::Session do
       }.to raise_error(Patron::UnsupportedSSLVersion)
     end
   end
-  
+
+  it "should work with different HTTP versions" do
+    ['HTTPv1_0','HTTPv1_1'].each do |version|
+      @session.http_version = version
+      response = @session.get("/test")
+      expect(response.status).to be == 200
+    end
+  end
+
+  it "should raise when an unsupported or unknown HTTP version is requested" do
+    ['something', 1].each do |version|
+      @session.http_version = version
+      expect {
+        @session.get("/test")
+      }.to raise_error(Patron::UnsupportedHTTPVersion)
+    end
+  end
+
   # ------------------------------------------------------------------------
   describe 'when debug is enabled' do
     it 'it should not clobber stderr' do

data/spec/support/test_server.rb

@@ -163,6 +163,14 @@ class WrongContentLengthServlet < HTTPServlet::AbstractServlet
   end
 end
 
+# Serves a substantial amount of data
+class LargeServlet < HTTPServlet::AbstractServlet
+  def do_GET(req, res)
+    res.content_length = 15 * 1024 * 1024
+    res.body = Random.new.bytes(15 * 1024 * 1024)
+  end
+end
+
 class PatronTestServer
 
   def self.start( log_file = nil, ssl = false, port = 9001 )
@@ -198,6 +206,7 @@ class PatronTestServer
     @server.mount("/redirect", RedirectServlet)
     @server.mount("/evil-redirect", EvilRedirectServlet)
     @server.mount("/picture", PictureServlet)
+    @server.mount("/very-large", LargeServlet)
     @server.mount("/setcookie", SetCookieServlet)
     @server.mount("/repetitiveheader", RepetitiveHeaderServlet)
     @server.mount("/wrongcontentlength", WrongContentLengthServlet)

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: patron
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Phillip Toland
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2016-09-05 00:00:00.000000000 Z
+date: 2017-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '10'
 - !ruby/object:Gem::Dependency
-  name: rake-compiler
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.5
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.5
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +56,16 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Ruby HTTP client library based on libcurl
 email:
 - phil.toland@gmail.com
@@ -130,11 +144,12 @@ files:
 - spec/util_spec.rb
 homepage: https://github.com/toland/patron
 licenses: []
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: |2
 
   Thank you for installing Patron. On OSX, make sure you are using libCURL with OpenSSL.
-  SecureTransport-based builds might cause crashes in forking environments.
+  SecureTransport-based builds might cause crashes in forking environment.
 
   For more info see https://github.com/curl/curl/issues/788
 rdoc_options: []
@@ -153,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.2.0
 requirements: []
 rubyforge_project: patron
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Patron HTTP Client