http 0.8.6 → 0.8.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54c45e83923cbc3784598961bd095891ecb59017
-  data.tar.gz: 4953e6ce3427e7db773c247930ecbf995d7723ef
+  metadata.gz: 04013fb3be8785ffad986b70b2d8110e47d88a8a
+  data.tar.gz: edaf6a058cb71d10dd3195830bbe20287b4f673a
 SHA512:
-  metadata.gz: 7e848c550021771ef39648f5ceeeb0dc246df75be6558ccd2d5a4b04597d9f1c574c236ccdb6b944dd2c3b5433f6480bc51b0cd638e9b64eed82847ea11b84d1
-  data.tar.gz: 41f0d37cfa7f2c01ead717b15d3798a1a655cd1e5b2b4c69c06e1c97ada4dbe22fb90fab8efe952bce13c18c95e5af7900208442351294ad0aa959284561ff1a
+  metadata.gz: bea10d0cffd4711074a4337d7ef2255593af098221d18776d9a9d0dd0815976d348eae4f9c9d825229fd6e5f5404a7f25efd8231214b16a1ed1dcbeba706b4fe
+  data.tar.gz: 2d37693d17444f69f62e2951549b0269fd962ef7f8f302584065a8d37ceb38ffc3d9a98832120b9327eaf2c16d17c8805c9c30e77858b0b33fe910b5c4f7ecc5

data/CHANGES.md

@@ -3,6 +3,16 @@
 * _the future is unwritten_
 
 
+## 0.8.7 (2015-05-08)
+
+* Fix `HTTP.timeout` API with options only given. (@ixti)
+
+
+## 0.8.6 (2015-05-08)
+
+* Reset global timeouts after the request finishes. See #215. (@zanker)
+
+
 ## 0.8.5 (2015-05-06)
 
 * Add simple timeouts configuration API. See #205. (@ixti)

data/README.md

@@ -277,18 +277,27 @@ storage URL supported by rack-cache is supported by http.rb's cache.
 
 ### Timeouts
 
-By default, HTTP does not timeout on a request. You can enable per operation (each read/write/connect call) or global (sum of all read/write/connect calls).
+By default, HTTP does not timeout on a request. You can enable per operation
+(each read/write/connect call) or global (sum of all read/write/connect calls).
 
 Per operation timeouts are what `Net::HTTP` and the majority of HTTP clients do:
 
 ``` ruby
-HTTP.timeout(:per_operation, :write => 2, :connect => 5, :read => 10).get "http://example.com"
+HTTP.timeout(:per_operation, :write => 2, :connect => 5, :read => 10)
+  .get "http://example.com"
+
+# For convinience, you can omit timeout type in this case. So following has
+# same result as the above:
+
+HTTP.timeout(:write => 2, :connect => 5, :read => 10).get "http://example.com"
 ```
 
-Global timeouts let you set an upper bound of how long a request can take, without having to rely on `Timeout.timeout`:
+Global timeouts let you set an upper bound of how long a request can take,
+without having to rely on `Timeout.timeout`:
 
 ``` ruby
-HTTP.timeout(:global, :write => 1, :connect => 1, :read => 1).get "http://example.com"
+HTTP.timeout(:global, :write => 1, :connect => 1, :read => 1)
+  .get "http://example.com"
 ```
 
 Uses a timeout of 3 seconds, for the entire `get` call.

data/lib/http/chainable.rb

@@ -81,13 +81,13 @@ module HTTP
     #   @option options [Float] :write Write timeout
     #   @option options [Float] :connect Connect timeout
     def timeout(klass, options = {})
-      klass, options = options, {} if klass.is_a? Hash
+      klass, options = :per_operation, klass if klass.is_a? Hash
 
       klass = case klass.to_sym
               when :null          then HTTP::Timeout::Null
               when :global        then HTTP::Timeout::Global
               when :per_operation then HTTP::Timeout::PerOperation
-              else fail Error, "Unsupported Timeout class: #{klass}"
+              else fail ArgumentError, "Unsupported Timeout class: #{klass}"
               end
 
       [:read, :write, :connect].each do |k|

data/lib/http/version.rb

@@ -1,3 +1,3 @@
 module HTTP
-  VERSION = "0.8.6"
+  VERSION = "0.8.7"
 end

data/spec/lib/http_spec.rb

@@ -220,4 +220,62 @@ RSpec.describe HTTP do
       end
     end
   end
+
+  describe ".timeout" do
+    context "without timeout type" do
+      subject(:client) { HTTP.timeout :read => 123 }
+
+      it "sets timeout_class to PerOperation" do
+        expect(client.default_options.timeout_class).
+          to be HTTP::Timeout::PerOperation
+      end
+
+      it "sets given timeout options" do
+        expect(client.default_options.timeout_options).
+          to eq :read_timeout => 123
+      end
+    end
+
+    context "with :null type" do
+      subject(:client) { HTTP.timeout :null, :read => 123 }
+
+      it "sets timeout_class to Null" do
+        expect(client.default_options.timeout_class).
+          to be HTTP::Timeout::Null
+      end
+    end
+
+    context "with :per_operation type" do
+      subject(:client) { HTTP.timeout :per_operation, :read => 123 }
+
+      it "sets timeout_class to PerOperation" do
+        expect(client.default_options.timeout_class).
+          to be HTTP::Timeout::PerOperation
+      end
+
+      it "sets given timeout options" do
+        expect(client.default_options.timeout_options).
+          to eq :read_timeout => 123
+      end
+    end
+
+    context "with :global type" do
+      subject(:client) { HTTP.timeout :global, :read => 123 }
+
+      it "sets timeout_class to Global" do
+        expect(client.default_options.timeout_class).
+          to be HTTP::Timeout::Global
+      end
+
+      it "sets given timeout options" do
+        expect(client.default_options.timeout_options).
+          to eq :read_timeout => 123
+      end
+    end
+
+    it "fails with unknown timeout type" do
+      expect { HTTP.timeout(:foobar, :read => 123) }.
+        to raise_error(ArgumentError, /foobar/)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http
 version: !ruby/object:Gem::Version
-  version: 0.8.6
+  version: 0.8.7
 platform: ruby
 authors:
 - Tony Arcieri
@@ -181,45 +181,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: HTTP should be easy
-test_files:
-- spec/lib/http/cache/headers_spec.rb
-- spec/lib/http/cache_spec.rb
-- spec/lib/http/client_spec.rb
-- spec/lib/http/content_type_spec.rb
-- spec/lib/http/headers/mixin_spec.rb
-- spec/lib/http/headers_spec.rb
-- spec/lib/http/options/body_spec.rb
-- spec/lib/http/options/form_spec.rb
-- spec/lib/http/options/headers_spec.rb
-- spec/lib/http/options/json_spec.rb
-- spec/lib/http/options/merge_spec.rb
-- spec/lib/http/options/new_spec.rb
-- spec/lib/http/options/proxy_spec.rb
-- spec/lib/http/options_spec.rb
-- spec/lib/http/redirector_spec.rb
-- spec/lib/http/request/caching_spec.rb
-- spec/lib/http/request/writer_spec.rb
-- spec/lib/http/request_spec.rb
-- spec/lib/http/response/body_spec.rb
-- spec/lib/http/response/caching_spec.rb
-- spec/lib/http/response/io_body_spec.rb
-- spec/lib/http/response/status_spec.rb
-- spec/lib/http/response/string_body_spec.rb
-- spec/lib/http/response_spec.rb
-- spec/lib/http_spec.rb
-- spec/spec_helper.rb
-- spec/support/black_hole.rb
-- spec/support/capture_warning.rb
-- spec/support/connection_reuse_shared.rb
-- spec/support/dummy_server.rb
-- spec/support/dummy_server/servlet.rb
-- spec/support/http_handling_shared.rb
-- spec/support/proxy_server.rb
-- spec/support/servers/config.rb
-- spec/support/servers/runner.rb
-- spec/support/ssl_helper.rb
+test_files: []
 has_rdoc: