throttler 0.2.2 → 0.2.3

data/README.md

@@ -1,26 +1,25 @@
 Throttler
 =========
 
-Throttler is a tired, cranky module that throttles parallel-running Ruby scripts on a single machine.
+Throttler is a tired, cranky module that helps you throttle stuff in parallel-running Ruby scripts on a single machine.
 
 ![Mapplethorpe](https://github.com/papercavalier/throttler/raw/master/mapplethorpe_chains.jpg)
 
 Example
 -------
 
-Our very own peculiar use case: We have multiple Resque workers hitting the Amazon IP on multiple addresses and want to make sure they don't fire more than once per locale per IP.
+Our very own use case: We have multiple Resque workers hitting the Amazon IP on multiple addresses and want to make sure they don't fire more than once per locale per IP.
+
+Here's some pseudo code:
 
     class Worker
       include Throttler
 
-      attr_accessor :locale,
-                    :interface
-
-      def perform
+      def perform(*args)
         scope = "#{locale}-#{interface}"
         freq  = 1.0
 
-        throttle(scope, interval) do
+        throttle(scope, freq) do
           # perform a request
         end
       end

data/lib/throttler/version.rb

@@ -1,4 +1,4 @@
 module Throttler #:nodoc:
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end
 

data/lib/throttler.rb

@@ -2,16 +2,13 @@ require "throttler/timer"
 
 # = Throttler
 #
-# An old, rusty throttler that gets the job done
+# A tired, cranky module that helps you throttle stuff in parallel-running Ruby
+# scripts on a single machine. It gets the job done.
 module Throttler
-
-  # Throttles the frequency in which a block is run
-  #
-  # Optionally pass a scope and interval.
-  def throttle(scope="throttler", interval=1.0)
+  def throttle(scope="throttler",freq=1.0)
     timer = Timer.new(scope)
     timer.lock
-    sleep [timer.timestamp + interval - Time.now.to_f, 0.0].max
+    sleep [timer.timestamp + freq - Time.now.to_f, 0.0].max
     timer.timestamp = Time.now.to_f
     timer.unlock
     yield if block_given?

data/spec/unit/throttler_spec.rb

@@ -27,7 +27,7 @@ describe Throttler do
     end
 
     context "by default" do
-      it "namespaces as `throttler`" do
+      it "names scope as `throttler`" do
         foo.throttle
         FileTest.exists?("/tmp/.throttler").should be_true
       end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Hakan Ensari
@@ -33,7 +33,7 @@ dependencies:
         version: 2.1.0
   type: :development
   version_requirements: *id001
-description: A tired, cranky module that throttles parallel-running Ruby scripts on a single machine.
+description: A tired, cranky module that helps you throttle stuff in parallel-running Ruby scripts on a single machine. A tired, cranky module that throttles parallel-running Ruby scripts on a single machine.
 email: 
 - code@papercavalier.com
 executables: []