throttler 0.1.0

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+ 
+Copyright (c) 2009 Paper Cavalier
+ 
+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/README.md

@@ -0,0 +1,26 @@
+Throttler
+=========
+
+![Mapplethorpe](http://github.com/papercavalier/throttler/raw/master/mapplethorpe_chains.jpg)
+
+Throttle concurrency.
+
+    include Throttler
+    
+    100.times do
+      Thread.new do
+        loop do
+          throttle("foo") do
+            count += 1
+          end
+        end
+      end
+    end
+    sleep 2.2
+    
+    count.should eql 3
+
+Use case
+--------
+
+Imagine multiple workers hitting the Amazon API on the same IP address. You gotta do something about it.

data/lib/throttler.rb

@@ -0,0 +1,23 @@
+# Throttler
+module Throttler
+  require "fileutils"
+
+  def throttle(name, interval=1.0)
+    path = "/tmp/.#{name}"
+
+    FileUtils.touch path unless File.exist? path
+
+    file = File.open(path, "r+")
+    file.flock(File::LOCK_EX)
+    
+    last = file.gets.to_f || Time.now.to_f - interval
+    sleep [last + interval - Time.now.to_f, 0.0].max
+
+    yield if block_given?
+
+    file.rewind
+    file.write(Time.now.to_f)
+    file.flock(File::LOCK_UN)
+    file.close    
+  end
+end

data/spec/fixtures/foo.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + "/../../lib/throttler"
+
+class Foo
+  include Throttler
+
+  def bar
+    throttle("bar") { noop }
+  end
+  
+  def noop; end
+end
+
+Foo.new.bar

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require "rspec"
+require File.expand_path("../../lib/throttler", __FILE__)
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each{ |f| require f }

data/spec/throttler_spec.rb

@@ -0,0 +1,78 @@
+require "benchmark"
+require "fileutils"
+require "spec_helper"
+
+class Foo
+  include Throttler
+
+  def bar
+    throttle("bar"){ noop }
+  end
+
+  def baz
+    throttle("baz"){ noop }
+  end
+
+  def noop; end
+end
+
+describe Throttler do
+  before do
+    FileUtils.rm "/tmp/.bar", :force => true
+    FileUtils.rm "/tmp/.baz", :force => true
+  end
+
+  it "throttles a loop" do
+    time = Benchmark.realtime do
+      3.times do
+        Foo.new.bar
+      end
+    end
+
+    time.should be_close 2, 0.01
+  end
+
+  it "throttles threads" do
+    count = 0
+    threads = 10.times.collect do
+      Thread.new do
+        foo = Foo.new
+        loop do
+          foo.bar
+          count += 1
+        end
+      end
+    end
+    sleep 2.2
+    threads.each { |t| Thread.kill(t) }
+
+    count.should eql 3
+  end
+
+  it "throttles concurrently-running scripts" do
+    time = Benchmark.realtime do
+      3.times do
+        `ruby #{File.dirname(__FILE__) + "/fixtures/foo.rb"}`
+      end
+    end
+
+    time.should be > 2.0
+  end
+
+  it "throttles by name" do
+    count = 0
+    threads = 10.times.collect do
+      Thread.new do
+        foo = Foo.new
+        loop do
+          count % 2 == 0 ? foo.bar : foo.baz
+          count += 1
+        end
+      end
+    end
+    sleep 2.2
+    threads.each { |t| Thread.kill(t) }
+
+    count.should eql 6
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: throttler
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Hakan Ensari
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-23 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Throttles the frequency at which concurrently-running instances of a Ruby block are executed.
+email: code@papercavalier.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- LICENSE
+- lib/throttler.rb
+- README.md
+- spec/fixtures/foo.rb
+- spec/spec_helper.rb
+- spec/throttler_spec.rb
+has_rdoc: true
+homepage: http://github.com/papercavalier/throttler
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Throttles the frequency at which concurrently-running instances of a Ruby block are executed.
+test_files: 
+- spec/fixtures/foo.rb
+- spec/spec_helper.rb
+- spec/throttler_spec.rb