rack-idle 0.1.0

data/README.rdoc

@@ -0,0 +1,51 @@
+= Rack::Idle
+
+Rack::Idle is a Rack middleware that will automatically shutdown idle Rack
+servers.
+
+== Installation
+
+  gem install rack-idle
+
+== Usage
+
+Add the following to your config.ru:
+  require "rack/idle"
+  
+  use Rack::Idle
+  
+  ...
+
+and once no requests have been received for 10 minutes +exit+ will be called to
+shutdown the server.
+
+The timeout can be customised like so:
+  use Rack::Idle, :timeout => 300 # 300 seconds == 5 minutes
+
+Additionally a file can be monitored, and the server shutdown if the timestamp
+is updated:
+  use Rack::Idle, :watch => "restart.txt" # touch restart.txt to shutdown
+
+== Licence
+
+(The MIT License)
+
+Copyright (c) 2012 Matthew Sadler
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/rack-idle.rb

@@ -0,0 +1 @@
+require File.expand_path("../rack/idle", __FILE__)

data/lib/rack/idle.rb

@@ -0,0 +1,72 @@
+module Rack # :nodoc:
+end
+
+# Rack::Idle is a Rack middleware that will automatically shutdown idle Rack
+# servers.
+# 
+# Just add the following to your config.ru:
+#   require "rack/idle"
+#   
+#   use Rack::Idle
+#   
+#   ...
+# 
+# and once no requests have been received for 10 minutes +exit+ will be called
+# to shutdown the server.
+# 
+# The timeout can be customised like so:
+#   use Rack::Idle, :timeout => 300 # 300 seconds == 5 minutes
+# 
+# Additionally a file can be monitored, and the server shutdown if the timestamp
+# is updated:
+#   use Rack::Idle, :watch => "restart.txt" # touch restart.txt to shutdown
+# 
+class Rack::Idle
+  
+  # :call-seq: Idle.new(app, [options]) -> idle
+  # 
+  # Create a new idle middleware instance, wrapping +app+.
+  # 
+  # Available options:
+  # [timeout] Amount of time (in seconds) to wait after a request before calling
+  #           +exit+ to shutdown the server
+  # 
+  # [watch]   Path to a file (relative to the working directory) to monitor,
+  #           shutting down the server if the last modified date is updated.
+  # 
+  def initialize(app, opts={})
+    @app = app
+    
+    self.class.last_activity = Time.now
+    timeout = (opts[:timeout] || 600)
+    
+    watch = opts[:watch]
+    if watch && File.exist?(watch)
+      watch_mtime = File.mtime(watch)
+    elsif watch
+      watch_mtime = Time.now
+    end
+    
+    Thread.new do
+      loop do
+        exit if Time.now - self.class.last_activity > timeout
+        exit if watch && File.exist?(watch) && File.mtime(watch) > watch_mtime
+        sleep 1
+      end
+    end.abort_on_exception = true
+  end
+  
+  class << self
+    attr_accessor :last_activity # :nodoc:
+  end
+  
+  # :call-seq: idle.call(env) -> status_headers_body
+  # 
+  # Proxied to the +app+ supplied to ::new.
+  # 
+  def call(env)
+    self.class.last_activity = Time.now
+    @app.call(env)
+  end
+  
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: rack-idle
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Matthew Sadler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-21 00:00:00.000000000Z
+dependencies: []
+description: Automatically shutdown idle Rack servers.
+email: mat@sourcetagsandcodes.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- lib/rack/idle.rb
+- lib/rack-idle.rb
+- README.rdoc
+homepage: http://github.com/matsadler/rack-idle
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.rdoc
+- --charset
+- utf-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Shutdown idle servers
+test_files: []