rack-timeout 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f4a3287d087373af78ba892d153244e803c4615
-  data.tar.gz: 6111fecabc946f4537890bc63ec9e60f1dae757c
+  metadata.gz: 84c611398a87d61130bbda91d3b98407a42b5906
+  data.tar.gz: 824bf643c7817f626c4a1f523b346b41a30ea97c
 SHA512:
-  metadata.gz: f609b6a82e645730dc47a945bcd2834424c4e1d68bfb1ff2f2462dcb2d1af36b77c8e7714da1df3ee00389c703101cd14484803c70c5d387a9f65d05803b0f3a
-  data.tar.gz: b1a9caec46c8fa8b6832b2c265fa39c53d625806cac669b9705b0ea496e637aa5a982885d582377aed98a9c0fc38b7073280033bfc5b75cb601a8c0bddfcbbdf
+  metadata.gz: c9d4f5e73090c55c0656c1880a0cd36eda06e062bf24989fb6d9a8eba290ab708b6c8a66646864ba780e37b16b9f391a250b53bfa029834a409d2e29afe80ac0
+  data.tar.gz: 73b9e72dd731472638cbb330582b6b93bd958809de61167e41f3fb138f4559c147ad6cf79e1b1c36a9318e5017e07b1a45d47f2e8dfbb04724e436323cc6d94e

data/README.markdown

@@ -164,19 +164,22 @@ If you're trying to test that a `Rack::Timeout::RequestTimeoutError` is raised i
 Observers
 ---------
 
-Observers are objects or blocks that are notified about state changes during a request's lifetime.
+Observers are blocks that are notified about state changes during a request's lifetime. Keep in mind that the `active` state is set every ~1s, so you'll be notified every time.
 
-You can register an observer easily with a block:
+You can register an observer with:
 
     Rack::Timeout.register_state_change_observer(:a_unique_name) { |env| do_things env }
 
-This is how logging is implemented, too. See `Rack::Timeout::StageChangeLoggingObserver`.
+There's currently no way to subscribe to changes into or out of a particular state. To check the actual state we're moving into, read `env['rack-timeout.info'].state`. Handling going out of a state would require some additional logic in the observer.
 
 You can remove an observer with `unregister_state_change_observer`:
 
     Rack::Timeout.unregister_state_change_observer(:a_unique_name)
 
-Custom observers might be used to store statistics on request length, timeouts, etc., and potentially do performance tuning on the fly.
+
+rack-timeout's logging is implemented using an observer; see `Rack::Timeout::StageChangeLoggingObserver` in logger.rb for the implementation.
+
+Custom observers might be used to do cleanup, store statistics on request length, timeouts, etc., and potentially do performance tuning on the fly.
 
 
 Logging
@@ -184,9 +187,9 @@ Logging
 
 Rack::Timeout logs a line every time there's a change in state in a request's lifetime.
 
-Changes into `timed_out` and `expired` are logged at the `ERROR` level, most other things are logged as `INFO`. The `active` state is logged as `DEBUG`, every ~1s while the request is still active.
+Request state changes into `timed_out` and `expired` are logged at the `ERROR` level, most other things are logged as `INFO`. The `active` state is logged as `DEBUG`, every ~1s while the request is still active.
 
-Rack::Timeout will try to use Rails.logger if present, otherwise it'll look for a logger in `env['rack.logger']`, and if neither are present, it'll create its own logger, either writing to `env['rack.errors']`, or to `$stderr` if the former is not set.
+Rack::Timeout will try to use `Rails.logger` if present, otherwise it'll look for a logger in `env['rack.logger']`, and if neither are present, it'll create its own logger, either writing to `env['rack.errors']`, or to `$stderr` if the former is not set.
 
 A custom logger can be set via `Rack::Timeout::StageChangeLoggingObserver.logger`. This takes priority over the automatic logger detection:
 

data/lib/rack/timeout.rb

@@ -29,7 +29,7 @@ module Rack
         unless value == false || (value.is_a?(Numeric) && value >= 0)
           raise ArgumentError, "value for #{property_name} should be false, zero, or a positive number."
         end
-        value = false if value.zero? # zero means we're disabling the feature
+        value = false if value && value.zero? # zero means we're disabling the feature
         instance_variable_set("@#{property_name}", value)
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-timeout
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Caio Chassot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-20 00:00:00.000000000 Z
+date: 2014-11-19 00:00:00.000000000 Z
 dependencies: []
 description: Rack middleware which aborts requests that have been running for longer
   than a specified timeout.