rack-delay 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1055f77eeedb3971ee085f94027664edd0295563
+  data.tar.gz: 80c959084f0fff29a83011062d22d65b94460d9b
+SHA512:
+  metadata.gz: a03cd24c0c16cf63855637c17443d4f72b604b393075936ac9683c2d3e8c0ddaae68fd1de478a558780937ba0aae6cbcfea648d841314bc1c53c793078de3b2c
+  data.tar.gz: 7640dbba80c71edfa4ae49fe797ed2290e4354edd94450b10381b21d6bfd6368390a45edc126bf6fac5a07683a0faef8de7ac9231d98e27011cad694d284e68d

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/README.md

@@ -0,0 +1,136 @@
+Rack-delay
+==========
+
+A simple rack middleware to add a random delay for requests, so you can simulate network latency during development.
+This library works with any rack capable framework, so you can use with sinatra or rails or whatever you want.
+
+## Install
+
+You can install this library via gem
+
+    gem install rack-delay
+
+or via Bundler adding
+
+```ruby
+gem 'rack-delay'
+```
+
+to your Gemfile and install:
+
+    bundle install
+
+
+## Usage
+
+To use rack-delay simply add it in config.ru file.
+Below is an example of middleware:
+
+```ruby
+# config.ru
+
+require 'rack/delay'
+
+use Rack::Delay
+
+app = proc do |env|
+  [ 200, {'Content-Type' => 'text/plain'}, "b" ]
+end
+
+run app
+```
+
+Rack-delay when use without options, will add a random delay to every request.
+You probably want to customize this behaviour, so you can pass options to middleware ex:
+
+```ruby
+# config.ru
+
+require 'rack/delay'
+
+use Rack::Delay, {
+  :min => 0,    # ms
+  :max => 5000, # ms
+  :if => lambda { |request|
+    request.xhr?
+  }
+}
+
+app = proc do |env|
+  [ 200, {'Content-Type' => 'text/plain'}, "b" ]
+end
+
+run app
+```
+
+In previous example rack-delay will add a random delay (between :min/:max) to every ajax requests.
+
+Also you can do more complex things like use a different delay for different requests, ex:
+
+```ruby
+# config.ru
+
+require 'rack/delay'
+
+use Rack::Delay, {
+  :delay => lambda { |request|
+    if request.get? # fixed 100ms delay to every get request
+      [100]
+    elsif request.post? # 300ms - 3sec delay to every post request
+      [300, 3000]
+    else
+      [0, rand(5000)] # use a random delay
+    end
+    
+    # if you not return a number from this block, rack-delay will use defaults range :min/:max to calc random delay
+  },
+  :if => lambda { |request|
+    request.xhr? and request.ip == '127.0.0.1'
+  }
+}
+
+app = proc do |env|
+  [ 200, {'Content-Type' => 'text/plain'}, "b" ]
+end
+
+run app
+```
+
+## Options
+
+Here a list of options which rack-delay can understand.  
+
+
+* **:min** / **:max**  
+  Specifies range in msec of random delay. When :min == :max delay will be fixed
+
+* **:delay**  
+  Another way to customize delay generation. Value returned by block can be a single number or 2 item array.  
+  When a number, then the request will be slowdown exactly by that number msec.  
+  If returns 2 items array (eg. [min, max]), then will be used to build range.
+
+* **:if** / **:unless**  
+  Used to control activation of rack-delay.  
+
+## Copyright
+
+Copyright (c) 2013 Vincenzo Farruggia.
+
+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/delay.rb

@@ -0,0 +1,77 @@
+module Rack
+  class Delay
+    HEADER = 'X-Rack-Delay'
+
+    attr_reader :app, :options
+
+    def initialize(app, options={})
+      @app     = app
+      
+      if options.has_key?(:unless)
+        options[:if] = options.delete(:unless)
+        options[:negate] = true
+      end
+
+      @options = {
+          :min    => 50,     # msec
+          :max    => 5000,   # msec
+          :delay  => nil,
+          :if     => nil,
+          :negate => false
+        }.merge(options)
+    end
+
+    def peek_delay(min, max)
+      if min > max
+        tmp = max
+        max = min
+        min = tmp
+      end
+      return min / 1000.0 if min == max
+      (min + rand(max - min)) / 1000.0
+    end
+
+    def _call_block(block, request)
+      if block.arity == 0
+        block.call()
+      else
+        block.call(request)
+      end
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+      should_delay = true
+      
+      
+      should_delay = !!_call_block(options[:if], request) if options[:if]
+      should_delay = !should_delay if options[:negate]
+
+      header_delay = 'none'
+      
+      if should_delay
+
+        min_delay = options[:min]
+        max_delay = options[:max]
+
+        if options[:delay]
+          ret = _call_block(options[:delay], request)
+          unless ret.nil?
+            ret = [ret] unless ret.kind_of?(Array)
+            min_delay = ret.first
+            max_delay = ret.last
+          end
+        end
+
+        delay = peek_delay(min_delay, max_delay)
+        header_delay = delay
+        sleep(delay)
+      end
+      
+      status , headers , response = app.call(env)
+      headers[ HEADER ] = header_delay.to_s
+      [status , headers , response]
+    end
+  end
+
+end

data/rack-delay.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name        = 'rack-delay'
+  s.version     = '0.2.0'
+  s.date        = '2013-04-17'
+  s.platform    = Gem::Platform::RUBY
+  s.summary     = %Q{#{ s.name } v#{ s.version }}
+  s.description = %q{A simple rack middleware to slowdown response}
+  s.authors     = ["Vincenzo Farruggia"]
+  s.email       = 'mastropinguino@networky.net'
+  s.files       = `git ls-files`.split($/)
+  s.license     = 'MIT'
+  s.require_paths = ['lib']
+  s.add_runtime_dependency 'rack'
+  s.homepage    =
+    'https://github.com/mastropinguino/rack-delay'
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: rack-delay
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Vincenzo Farruggia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple rack middleware to slowdown response
+email: mastropinguino@networky.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README.md
+- lib/rack/delay.rb
+- rack-delay.gemspec
+homepage: https://github.com/mastropinguino/rack-delay
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: rack-delay v0.2.0
+test_files: []