patron 0.12.1 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d150d662006fa9751021e94126b0ef52432fb45
-  data.tar.gz: 240cfef423d0c4aec7c363da618bbd8966d9d8a0
+  metadata.gz: cdaf7a10ef1cf673746f7f87ae77a9d939b461fc
+  data.tar.gz: 772139466802595a3906e24f297da437de3df880
 SHA512:
-  metadata.gz: 75e5e3b6c0c4df36c763ee3a84efdd0771599aae2eed85fb0c8f91596d9304a06e2a209f1b06283b1a461d88dfe6a3eebd34f594e18f7b57bb44d119a256fbed
-  data.tar.gz: d5ae239b30d06e0c143d2fe821bf5110f17aa811b83c69ccabb02e1d2b4a96a954e3eb9fc5509fdd88adc4fc765db0ce53f537e788c6873e769b494005536e94
+  metadata.gz: 94787a3fd98f9253862432e8069c5088dfc703f3bb6e69ebb2e60f86d70a489a8cb2c72d2134e690649d0e908ff08068631e0cc148f41b331fca5cf4f95dc6cb
+  data.tar.gz: 19496dff4f0687cbcd664c3aa81969c5b1a810aba28f87ab9f918a05771a5567d348acdc8b862c2b430e9304854796e034fc9d68361aa2d5b16e2cd0b17bd63b

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 0.13.0
+
+* Permit timeouts to be set as a Float of seconds and use `CURLOPT_(CONNECT)TIMEOUT_MS` instead of `CURLOPT_(CONNECT)TIMEOUT` so that
+  sub-second timeouts can be configured, which is useful for performant services using accelerated DNS resolution.
+* Remove the restriction that `Session#timeout` should be non-zero - a timeout set to 0 means "no timeout" in libCURL
+
 ### 0.12.1
 
 * Ensure HTTP2 response headers/status lines are correctly handled

data/ext/patron/session_ext.c

@@ -401,6 +401,12 @@ static void set_request_body_file(struct patron_curl_state* state, VALUE r_path_
   #endif
 }
 
+static long floating_rb_seconds_to_milliseconds(VALUE r_seconds) {
+  double seconds_f = NUM2DBL(r_seconds);
+  long millis = seconds_f * (double)1000.0;
+  return millis;
+}
+
 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"))) {
@@ -580,12 +586,12 @@ static void set_options_from_request(VALUE self, VALUE request) {
     
   timeout = rb_funcall(request, rb_intern("timeout"), 0);
   if (RTEST(timeout)) {
-    curl_easy_setopt(curl, CURLOPT_TIMEOUT, FIX2INT(timeout));
+    curl_easy_setopt(curl, CURLOPT_TIMEOUT_MS, floating_rb_seconds_to_milliseconds(timeout));
   }
 
   timeout = rb_funcall(request, rb_intern("connect_timeout"), 0);
   if (RTEST(timeout)) {
-    curl_easy_setopt(curl, CURLOPT_CONNECTTIMEOUT, FIX2INT(timeout));
+    curl_easy_setopt(curl, CURLOPT_CONNECTTIMEOUT_MS, floating_rb_seconds_to_milliseconds(timeout));
   }
 
   timeout = rb_funcall(request, rb_intern("dns_cache_timeout"), 0);

data/lib/patron/request.rb

@@ -88,26 +88,28 @@ module Patron
       @action = action.downcase.to_sym
     end
 
-    # Sets the read timeout for the CURL request, in seconds
+    # Sets the read timeout for the CURL request, in seconds.
+    # Can be set to less than a second using a floating-point value.
+    # Setting the value to 0 will disable the timeout.
     #
     # @param new_timeout[Integer] the number of seconds to wait before raising a timeout error
     def timeout=(new_timeout)
-      if new_timeout && new_timeout.to_i < 1
-        raise ArgumentError, "Timeout must be a positive integer greater than 0"
+      if new_timeout && new_timeout.to_f < 0
+        raise ArgumentError, "Timeout must be a positive number"
       end
-
-      @timeout = new_timeout.to_i
+      @timeout = new_timeout.to_f
     end
 
     # Sets the connect timeout for the CURL request, in seconds.
+    # Can be set to less than a second using a floating-point value.
     #
     # @param new_timeout[Integer] the number of seconds to wait before raising a timeout error
     def connect_timeout=(new_timeout)
-      if new_timeout && new_timeout.to_i < 1
-        raise ArgumentError, "Timeout must be a positive integer greater than 0"
+      if new_timeout && new_timeout.to_f < 0
+        raise ArgumentError, "Timeout must be a positive number"
       end
 
-      @connect_timeout = new_timeout.to_i
+      @connect_timeout = new_timeout.to_f
     end
     
     # Sets the maximum number of redirects that are going to be followed.

data/lib/patron/version.rb

@@ -1,3 +1,3 @@
 module Patron
-  VERSION = "0.12.1"
+  VERSION = "0.13.1"
 end

data/patron.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   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"
 
@@ -39,7 +39,7 @@ For more info see https://github.com/curl/curl/issues/788
   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 "yard", "~> 0.9.11"
   spec.add_development_dependency "rack", "~> 1"
   spec.add_development_dependency "puma", '~> 3.11'
   spec.add_development_dependency "rake-compiler"

data/spec/request_spec.rb

@@ -27,10 +27,6 @@ describe Patron::Request do
       expect {@request.timeout = -1}.to raise_error(ArgumentError)
     end
 
-    it "should raise an exception when assigned 0" do
-      expect {@request.timeout = 0}.to raise_error(ArgumentError)
-    end
-
   end
 
   describe :max_redirects do

data/spec/session_spec.rb

@@ -173,7 +173,12 @@ describe Patron::Session do
 
   it "should raise an exception on timeout" do
     @session.timeout = 1
-    expect {@session.get("/timeout")}.to raise_error(Patron::TimeoutError)
+    expect {@session.get("/timeout?millis=1100")}.to raise_error(Patron::TimeoutError)
+  end
+
+  it "should raise an exception on a sub-second timeout" do
+    @session.timeout = 0.3
+    expect {@session.get("/timeout?millis=400")}.to raise_error(Patron::TimeoutError)
   end
 
   it "should raise an exception on timeout when reading from a slow resource" do

data/spec/session_ssl_spec.rb

@@ -73,7 +73,9 @@ describe Patron::Session do
 
   it "should raise an exception on timeout" do
     @session.timeout = 1
-    expect {@session.get("/timeout")}.to raise_error(Patron::TimeoutError)
+    expect {
+      @session.get("/timeout?millis=1100")
+    }.to raise_error(Patron::TimeoutError)
   end
 
   it "should follow redirects by default" do

data/spec/support/config.ru

@@ -51,7 +51,9 @@ GzipServlet = Proc.new {|env|
 }
 
 TimeoutServlet = Proc.new {|env|
-  sleep 1.1
+  query_vars = Rack::Utils.parse_nested_query(env.fetch('QUERY_STRING'))
+  query_millis = query_vars.fetch('millis').to_i
+  sleep(query_millis / 1000.0)
   [200, {'Content-Type' => 'text/plain'}, ['That took a while']]
 }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: patron
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.13.1
 platform: ruby
 authors:
 - Phillip Toland
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-20 00:00:00.000000000 Z
+date: 2018-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.11
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -204,7 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.2.0
 requirements: []
 rubyforge_project: patron
-rubygems_version: 2.6.11
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Patron HTTP Client