rack-timeout 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a99f11768e4de71a88bbc6eafa4bbb5817cf639
-  data.tar.gz: 1e5d53984df8f0152c945a9dd2d19a0c60a0b78a
+  metadata.gz: 5c350e40f59d01af35e44aa9caebf66752f30e15
+  data.tar.gz: f5f0133eb613f110cff035afee6dd512eb0a0d10
 SHA512:
-  metadata.gz: ae467f02c8ceefed9e53a40214595a9e3daa2f28b71500b1f28230e322f420e07b1f0bac83b0115e9dae8b13df4100bd734d64b007959e697afb773530286633
-  data.tar.gz: 5926a3baff52db4aa3bb7a2c63c3c988431820565faaef508e2420f34ae1b8ca86b0b09762d229dadb215308a007c1116344c9bf607f788a7ace13487d71225f
+  metadata.gz: 805fe810b977eb29867df02daac8f10eeb28344c57fa8bb1d91ee3a45dc3fd6a59d525db64986f0a3f51d27923dc48c95ef3bcd0ecf838bf03106aa8ef95ab4d
+  data.tar.gz: 704345ef0762eb668eb3a6a8d0ef08c3e4cfad85a6aad0ab332986afc1cd6b52d72e6b785b57cb64f502fc1dd0c652747b34ab557eb30eeabf50e0b022a82253

data/README.markdown

@@ -17,20 +17,26 @@ The following covers currently supported versions of Rails, Rack, Ruby, and Bund
 
 ### Rails apps
 
-    # Gemfile
-    gem "rack-timeout"
+```ruby
+# Gemfile
+gem "rack-timeout"
+```
 
 That's all that's required if you want to use the default timeout of 15s. To use a custom timeout, create an initializer file:
 
-    # config/initializers/timeout.rb
-    Rack::Timeout.timeout = 5  # seconds
+```ruby
+# config/initializers/timeout.rb
+Rack::Timeout.timeout = 5  # seconds
+```
 
 ### Sinatra and other Rack apps
 
-    # config.ru
-    require "rack-timeout"
-    use Rack::Timeout          # Call as early as possible so rack-timeout runs before all other middleware.
-    Rack::Timeout.timeout = 5  # Recommended. If omitted, defaults to 15 seconds.
+```ruby
+# config.ru
+require "rack-timeout"
+use Rack::Timeout          # Call as early as possible so rack-timeout runs before all other middleware.
+Rack::Timeout.timeout = 5  # Recommended. If omitted, defaults to 15 seconds.
+```
 
 
 The Rabbit Hole
@@ -168,13 +174,17 @@ Observers are blocks that are notified about state changes during a request's li
 
 You can register an observer with:
 
-    Rack::Timeout.register_state_change_observer(:a_unique_name) { |env| do_things env }
+```ruby
+Rack::Timeout.register_state_change_observer(:a_unique_name) { |env| do_things env }
+```
 
 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)
+```ruby
+Rack::Timeout.unregister_state_change_observer(:a_unique_name)
+```
 
 
 rack-timeout's logging is implemented using an observer; see `Rack::Timeout::StageChangeLoggingObserver` in logger.rb for the implementation.
@@ -193,21 +203,27 @@ Rack::Timeout will try to use `Rails.logger` if present, otherwise it'll look fo
 
 A custom logger can be set via `Rack::Timeout::StageChangeLoggingObserver.logger`. This takes priority over the automatic logger detection:
 
-    Rack::Timeout::StageChangeLoggingObserver.logger = Logger.new
+```ruby
+Rack::Timeout::StageChangeLoggingObserver.logger = Logger.new
+```
 
 When creating its own logger, rack-timeout will use a log level of `INFO`. Otherwise whatever log level is already set on the logger being used continues in effect.
 
 Logging is enabled by default if Rack::Timeout is loaded via the `rack-timeout` file (recommended), but can be removed by unregistering its observer:
 
-    Rack::Timeout.unregister_state_change_observer(:logger)
+```ruby
+Rack::Timeout.unregister_state_change_observer(:logger)
+```
 
 Each log line is a set of `key=value` pairs, containing the entries from the `env["rack-timeout.info"]` struct that are not `nil`. See the Request Lifetime section above for a description of each field. Note that while the values for `wait`, `timeout`, and `service` are stored internally as seconds, they are logged as milliseconds for readability.
 
 A sample log excerpt might look like:
 
-    source=rack-timeout id=13793c wait=369ms timeout=10000ms state=ready at=info
-    source=rack-timeout id=13793c wait=369ms timeout=10000ms service=15ms state=completed at=info
-    source=rack-timeout id=ea7bd3 wait=371ms timeout=10000ms state=timed_out at=error
+```
+source=rack-timeout id=13793c wait=369ms timeout=10000ms state=ready at=info
+source=rack-timeout id=13793c wait=369ms timeout=10000ms service=15ms state=completed at=info
+source=rack-timeout id=ea7bd3 wait=371ms timeout=10000ms state=timed_out at=error
+```
 
 
 Compatibility

data/lib/rack/timeout.rb

@@ -80,7 +80,7 @@ module Rack
         info.wait, info.timeout = seconds_waited, final_wait_timeout       # updating the info properties; info.timeout will be the wait timeout at this point
         if seconds_service_left <= 0 # expire requests that have waited for too long in the queue (as they are assumed to have been dropped by the web server / routing layer at this point)
           RT._set_state! env, :expired
-          raise RequestExpiryError, "Request older than #{final_wait_timeout} seconds."
+          raise RequestExpiryError, "Request older than #{info.ms(:timeout)}."
         end
       end
 
@@ -103,7 +103,7 @@ module Rack
             sleep(sleep_seconds)
           end
           RT._set_state! env, :timed_out
-          app_thread.raise(RequestTimeoutError, "Request #{"waited #{info.ms(:wait)} seconds, then " if info.wait}ran for longer than #{info.ms(:timeout)}")
+          app_thread.raise(RequestTimeoutError, "Request #{"waited #{info.ms(:wait)}, then " if info.wait}ran for longer than #{info.ms(:timeout)}")
         end
         response = @app.call(env)
       ensure

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-timeout
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Caio Chassot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-21 00:00:00.000000000 Z
+date: 2015-03-12 00:00:00.000000000 Z
 dependencies: []
 description: Rack middleware which aborts requests that have been running for longer
   than a specified timeout.
@@ -42,8 +42,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Abort requests that are taking too long
 test_files: []
+has_rdoc: