redis_support 0.0.9 → 0.0.10

data/lib/redis_support/locks.rb

@@ -16,6 +16,15 @@ module RedisSupport
       release_redis_lock( key_to_lock )
     end
 
+    # Throttle a block of code so it is only executed at most every
+    # `expiration` seconds. The block is skipped if it has been run
+    # more recently.
+    #
+    # Returns nothing
+    def redis_throttle( key_to_lock, expiration = 30 )
+      yield if acquire_redis_lock_nonblock( key_to_lock, expiration )
+    end
+
     # Acquire a lock on a key in our Redis database. This is a blocking
     # call. It sleeps until the lock has been successfully acquired.
     #
@@ -25,6 +34,19 @@ module RedisSupport
     #   # do some stuff on my_key
     #   release_redis_lock( key.my_key )
     #
+    # interval    - sleep interval for checking the lock's status.
+    #
+    # Returns nothing.
+    def acquire_redis_lock( key_to_lock, expiration = 30, interval = 1 )
+      until acquire_redis_lock_nonblock( key_to_lock, expiration )
+        sleep interval
+      end
+    end
+
+    # Attempt to acquire a lock on a key in our Redis database.
+    #
+    # Returns true on success and false on failure
+    #
     # Described in detail here:
     #
     #   http://code.google.com/p/redis/wiki/SetnxCommand
@@ -40,30 +62,19 @@ module RedisSupport
     #               amount of time others will wait for you, not the amount of time
     #               you will wait to acquire the lock.
     #
-    # interval    - sleep interval for checking the lock's status.
-    #   
-    # Returns nothing.
-    def acquire_redis_lock( key_to_lock, expiration = 30, interval = 1 )
+    def acquire_redis_lock_nonblock( key_to_lock, expiration = 30 )
       key = lock_key( key_to_lock )
-      until redis.setnx key, timeout_i( expiration )
+      if redis.setnx key, timeout_i( expiration )
+        return true
+      else
         if redis.get( key ).to_i < Time.now.to_i
           old_timeout = redis.getset( key, timeout_i( expiration ) ).to_i
           if old_timeout < Time.now.to_i
-            return # got it!
+            return true
           end
-        else
-          sleep interval
         end
       end
-    end
-
-    # Acquire a redis lock only if it can be acquired
-    # is a nonblocking action
-    #
-    # Returns true on success and false on failure
-    def acquire_redis_lock_nonblock( key_to_lock, expiration = 30 ) 
-      key = lock_key( key_to_lock ) 
-      redis.setnx key, timeout_i( expiration )
+      false
     end
     
     # See docs for acquire_redis_lock above
@@ -95,6 +106,5 @@ module RedisSupport
     def timeout_i( timeout )
       timeout.seconds.from_now.to_i
     end
-
   end
 end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: redis_support
 version: !ruby/object:Gem::Version 
-  hash: 13
   prerelease: false
   segments: 
   - 0
   - 0
-  - 9
-  version: 0.0.9
+  - 10
+  version: 0.0.10
 platform: ruby
 authors: 
 - Brian P O'Rourke
@@ -16,25 +15,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-24 00:00:00 -07:00
+date: 2010-07-01 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
+  name: redis
+  type: :runtime
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 31
         segments: 
         - 1
         - 0
         - 4
         version: 1.0.4
-  type: :runtime
-  name: redis
   prerelease: false
-  version_requirements: *id001
+  requirement: *id001
 description: "Module for adding redis functionality to classes: simple key namespacing and locking and connections"
 email: dolores@doloreslabs.com
 executables: []
@@ -48,8 +45,6 @@ files:
 - lib/redis_support/class_extensions.rb
 - lib/redis_support/locks.rb
 - README.md
-- test/helper.rb
-- test/test_redis_support.rb
 has_rdoc: true
 homepage: http://github.com/dolores/redis_support
 licenses: []
@@ -60,27 +55,23 @@ rdoc_options:
 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
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A Redis Support module