redis_locks 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e54f88975c7c22202a262495733bef3bbf25384b
+  data.tar.gz: dd6f4a948434588a31ec2086b0bce9e90fb29680
+SHA512:
+  metadata.gz: 9c96f4d857b9461508678e335797dda5ffa2b625902ea43621b4af3c1b0efa59b10fd9c71448880dbef58abd2f8354afca7e4f7f9acc82ab435670fef506466f
+  data.tar.gz: ac7146e7944e074836d66eef2f12e908b637194151812ac9c96b689944ad66c5264f4029afb1612bae807e1eac0e2ddcb191715dd968efb19540752c2028837a

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in cached_counts.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+gem 'pry', group: [:development, :test]

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    redis_locks (0.0.1)
+      redis
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.1)
+    diff-lcs (1.2.5)
+    method_source (0.8.2)
+    pry (0.10.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (11.1.2)
+    redis (3.2.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  rake
+  redis_locks!
+  rspec
+
+BUNDLED WITH
+   1.11.2

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,89 @@
+# redis-locks
+Various locking utilities for Ruby using Redis.
+
+All classes are designed to work with Ruby clients distributed across multiple
+processes and/or machines, but assume a single Redis master for correctness.
+
+Works with Redis 2.6+.
+
+# Utilities
+
+## RedisLocks::Mutex
+
+A simple mutex using `setnx`.
+
+```ruby
+  require 'redis'
+  require 'redis_locks'
+
+  lock = RedisLocks::Mutex.new('my_key', redis: Redis.new)
+
+  # high-level use
+  lock.lock! do 
+    # something that can only be done by one process at a time
+  end
+
+  # lower-level options
+  lock.lock # acquires lock & returns true
+  lock.lock # returns false, lock was not acquired
+  lock.unlock # now lock can be acquired again
+```
+
+Supports lock expiry via `expires_in`/`expires_at` arguments to the constructor.
+By default, locks expire after 24 hours.
+
+
+## RedisLocks::Semaphore
+
+A semaphore implemented with Lua and `lpop`/`blpop`. 
+
+Supports multiple resources, waits to acquire a resource, and timeouts.
+
+```ruby
+  require 'redis'
+  require 'redis_locks'
+
+  semaphore = RedisLocks::Semaphore.new('my_key', redis: Redis.new, resources: 2)
+
+  # high-level use
+  semaphore.lock! do
+    # something that can be done by at most two processes at a time
+  end
+
+  # will wait indefinitely for a resource to be free, if necessary (this
+  # counter-intuitive use of zero values reflects that of Redis' `blpop`)
+  semaphore.lock!(timeout: 0) { }
+
+  # will wait up to 1 second for a resource to be free
+  semaphore.lock!(timeout: 1) { }
+
+  # lower-level options
+  semaphore.lock # acquires resource & returns true
+  semaphore.lock # acquires another resource & returns true
+  semaphore.lock # returns false, no resources remain
+  semaphore.unlock # frees a resource
+```
+
+Supports expiry via `stale_client_timeout` argument to the constructor.
+By default, clients are timed out after 24 hours.
+
+## RedisLocks::TokenBucket
+
+A [token-bucket](https://en.wikipedia.org/wiki/Token_bucket) rate limiter implemented with Lua.
+
+```ruby
+  require 'redis'
+  require 'redis_locks'
+
+  # allows up to two calls to `take`/`take!` every five seconds
+  limiter = RedisLocks::TokenBucket.new('my_key', redis: Redis.new, period: 5, number: 2)
+
+  2.times { limiter.take! }
+
+  limiter.take # false if zero microseconds have passed, true otherwise (in which case a new token has become available)
+  limiter.take! # raises RateLimitExceeded
+
+  sleep(5)
+
+  limiter.take # true
+```

data/Rakefile

@@ -0,0 +1,16 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  rdoc.main = "README.md"
+  rdoc.rdoc_files.include("README.md", "lib/**/*.rb")
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/lib/redis_locks.rb

@@ -0,0 +1,9 @@
+require 'redis_locks/version'
+require 'redis_locks/resource_unavailable'
+require 'redis_locks/evalsha_or_eval'
+require 'redis_locks/mutex'
+require 'redis_locks/semaphore'
+require 'redis_locks/token_bucket'
+
+module RedisLocks
+end

data/lib/redis_locks/evalsha_or_eval.rb

@@ -0,0 +1,15 @@
+module RedisLocks
+
+  # This ensures that each Lua script is evaluated at most once; after it has
+  # been evaluated, we will be able to call it just by passing its digest.
+  def self.evalsha_or_eval(redis:, script:, digest:, keys: [], args: [])
+    redis.evalsha digest, keys, args
+  rescue Redis::CommandError => e
+    if e.message.start_with?('NOSCRIPT')
+      redis.eval script, keys, args
+    else
+      raise
+    end
+  end
+
+end

data/lib/redis_locks/mutex.rb

@@ -0,0 +1,66 @@
+module RedisLocks
+  class AlreadyLocked < ResourceUnavailable
+    def initialize(key)
+      super("Key [#{key}] already locked!")
+    end
+  end
+
+  class Mutex
+
+    NAMESPACE = "mutex"
+
+    def initialize(key, redis:, expires_in: 86400, expires_at: nil)
+      @key = "#{NAMESPACE}:#{key}"
+      @redis = redis
+      @expires_at = (expires_at.to_i if expires_at) || (Time.now.utc.to_i + expires_in)
+    end
+
+    def lock(&block)
+      now = Time.now.utc.to_i
+      locked = false
+
+      if @redis.setnx(@key, @expires_at)
+        @redis.expire(@key, @expires_at - now)
+        locked = true
+      else # it was locked
+        if (old_value = @redis.get(@key)).to_i <= now
+          # lock has expired
+          if @redis.getset_value(@key, @expires_at) == old_value
+            locked = true
+          end
+        end
+      end
+
+      return false unless locked
+
+      return_or_yield(&block)
+    end
+
+    def lock!(&block)
+      locked = lock
+      raise AlreadyLocked.new(@key) unless locked
+      return_or_yield(&block)
+    end
+
+    # only delete the key if it's still valid, and will be for another 2 seconds
+    def unlock
+      if Time.now.utc.to_i - 2 < @expires_at
+        @redis.del(@key)
+      end
+    end
+
+    private
+
+    def return_or_yield
+      return_value = true
+      if block_given?
+        begin
+          return_value = yield
+        ensure
+          unlock
+        end
+      end
+      return_value
+    end
+  end
+end

data/lib/redis_locks/resource_unavailable.rb

@@ -0,0 +1,4 @@
+module RedisLocks
+  class ResourceUnavailable < RuntimeError
+  end
+end

data/lib/redis_locks/semaphore.rb

@@ -0,0 +1,199 @@
+# Adapted from https://github.com/dv/redis-semaphore - switched to use Lua
+# instead of broken mutex implementation, see issue #23 on GitHub.
+#
+# Options we don't use were removed for simplicity.
+#
+# Original copyright (C) 2011 by David Verhasselt (david@crowdway.com)
+#
+# 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.
+#
+require 'digest'
+
+module RedisLocks
+  class SemaphoreUnavailable < ResourceUnavailable
+    def initialize(key, resources)
+      super("Key [#{key}] has 0/#{resources} resources available!")
+    end
+  end
+
+  class Semaphore
+
+    NAMESPACE = "semaphore-lua"
+
+    # Removes stale locks, then ensures that all resources which aren't locked
+    # are marked as available.
+    SETUP_SCRIPT = <<-LUA
+      local avail_key = KEYS[1]
+      local grabbed_key = KEYS[2]
+
+      local expected_resources = tonumber(ARGV[1])
+      local stale_before = tonumber(ARGV[2])
+
+      redis.call('zremrangebyscore', grabbed_key, -1, stale_before)
+
+      local found_resources = redis.call('llen', avail_key) + redis.call('zcard', grabbed_key)
+      if found_resources < expected_resources then
+        for i=1,(expected_resources - found_resources) do
+          redis.call('rpush', avail_key, 1)
+        end
+      end
+    LUA
+
+    SETUP_DIGEST = Digest::SHA1.hexdigest(SETUP_SCRIPT)
+
+    # `resources` is the number of clients allowed to lock the semaphore
+    # concurrently.
+    #
+    # `stale_client_timeout` is the threshold of time before we assume that
+    # something has gone terribly wrong with a client and we invalidate its lock.
+    def initialize(key, redis:, resources: 1, stale_client_timeout: 86400)
+      @key = key
+      @resource_count = resources.to_i
+      @stale_client_timeout = stale_client_timeout.to_f
+      @redis = redis
+      @tokens = []
+
+      raise ArgumentError.new("Lock key is required") if @key.nil? || @key.empty?
+      raise ArgumentError.new("resources must be > 0") unless @resource_count > 0
+      raise ArgumentError.new("stale_client_timeout must be > 0") unless @stale_client_timeout > 0
+    end
+
+    # Forcefully clear the lock. Be careful!
+    def delete!
+      @redis.del(available_key)
+      @redis.del(grabbed_key)
+      @tokens = []
+    end
+
+    # Acquire a resource from the semaphore, if available. Returns false if no
+    # resources are available.
+    #
+    # `timeout` is how long to wait, blocking, until a resource is available.
+    # The default is nil, meaning don't block. A timeout of zero means block forever.
+    # (This is a bit weird, but corresponds to how blpop uses timeout values.)
+    #
+    # If passed a block, if a resource is available, runs the block and then
+    # unlocks.
+    #
+    # If called without a block, if a resource is available, returns a token.
+    # Caller is then responsible for unlocking the token.
+    #
+    # This isn't atomic--if the process dies, we could remove something from the
+    # available queue without adding it to the grabbed set--but that's ok, the
+    # semaphore will recover just as if this was a stale client that left its
+    # token in the grabbed set forever.
+    def lock(timeout: nil, &block)
+      ensure_exists_and_release_stale_locks!
+
+      success =
+        if timeout
+          !@redis.blpop(available_key, timeout.to_i).nil?
+        else
+          !@redis.lpop(available_key).nil?
+        end
+
+      return false unless success
+
+      token = SecureRandom.hex(16)
+      @tokens.push(token)
+      @redis.zadd(grabbed_key, epoch_f, token)
+
+      return_or_yield(token, &block)
+    end
+
+    def wait(timeout: 0, &block)
+      lock(timeout: timeout, &block)
+    end
+
+    def lock!(timeout: nil, &block)
+      token = lock(timeout: timeout)
+      raise SemaphoreUnavailable.new(@key, @resource_count) unless token
+      return_or_yield(token, &block)
+    end
+
+    def wait!(timeout: 0, &block)
+      lock!(timeout: timeout, &block)
+    end
+
+    # Release a resource back to the semaphore. Should normally be called with an
+    # explicit token.
+    #
+    # This isn't atomic--if the process dies, we could remove something from the
+    # blocked set without adding it to the available queue--but that's ok, the
+    # semaphore will recover just as if this was a stale client that left its
+    # token in the grabbed set forever.
+    def unlock(token = @tokens.pop)
+      return unless token
+
+      removed = @redis.zrem grabbed_key, token
+      if removed
+        @redis.lpush available_key, 1
+      end
+
+      removed
+    end
+    alias_method :signal, :unlock
+
+    private
+
+    def return_or_yield(token)
+      return_value = token
+      if block_given?
+        begin
+          return_value = yield token
+        ensure
+          unlock(token)
+        end
+      end
+      return_value
+    end
+
+    def ensure_exists_and_release_stale_locks!
+      RedisLocks.evalsha_or_eval(
+        redis: @redis,
+        script: SETUP_SCRIPT,
+        digest: SETUP_DIGEST,
+        keys: [available_key, grabbed_key],
+        args: [@resource_count, stale_before]
+      )
+    end
+
+    def namespaced_key(variable)
+      "#{NAMESPACE}:#{@key}:#{variable}"
+    end
+
+    def available_key
+      @available_key ||= namespaced_key('AVAILABLE')
+    end
+
+    def grabbed_key
+      @grabbed_key ||= namespaced_key('GRABBED')
+    end
+
+    def stale_before
+      epoch_f - @stale_client_timeout
+    end
+
+    def epoch_f
+      epoch_i, microseconds = @redis.time
+      epoch_i + microseconds.to_f / 1_000_000
+    end
+
+  end
+end

data/lib/redis_locks/token_bucket.rb

@@ -0,0 +1,69 @@
+require 'digest'
+
+module RedisLocks
+  class RateLimitExceeded < ResourceUnavailable
+    def initialize(key, rps)
+      super("Rate limit of #{rps}/second on [#{key}] exceeded!")
+    end
+  end
+
+  class TokenBucket
+
+    NAMESPACE = "token-bucket"
+
+    SCRIPT = <<-LUA
+      local epoch = tonumber(ARGV[1])
+      local rps = tonumber(ARGV[2])
+      local burst = tonumber(ARGV[3])
+      local key = KEYS[1]
+
+      local token = 1.0 / rps
+      local t = redis.call('get', key)
+      if not t then
+        t = epoch
+      else
+        t = tonumber(t)
+      end
+
+      if t < epoch then
+        t = epoch
+      elseif t > (epoch + (burst * token)) then
+        return 0
+      end
+
+      redis.call('set', key, t + token)
+      return 1
+    LUA
+
+    DIGEST = Digest::SHA1.hexdigest(SCRIPT)
+
+    # `number` tokens are added to the bucket every `period` seconds (up to a
+    # max of `number` tokens being available). Each time a resource is used, a
+    # token is removed from the bucket; if no tokens are available, no resource
+    # may be used.
+    def initialize(key, redis:, period: 1, number: 1)
+      @key = "#{NAMESPACE}:#{key}".freeze
+      @rps = number.to_f / period.to_i
+      @burst = number.to_i
+      @redis = redis
+    end
+
+    def take
+      epoch_i, microseconds = @redis.time
+      epoch_f = epoch_i + (microseconds.to_f/1_000_000)
+      took = RedisLocks.evalsha_or_eval(
+        redis: @redis,
+        script: SCRIPT,
+        digest: DIGEST,
+        keys: [@key],
+        args: [epoch_f, @rps, @burst]
+      )
+      took == 1
+    end
+
+    def take!
+      raise RateLimitExceeded.new(@key, @rps) unless take
+    end
+
+  end
+end

data/lib/redis_locks/version.rb

@@ -0,0 +1,3 @@
+module RedisLocks
+  VERSION = '0.0.1'
+end

data/redis_locks.gemspec

@@ -0,0 +1,26 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "redis_locks/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "redis_locks"
+  s.version     = RedisLocks::VERSION
+  s.authors     = ["Academia.edu"]
+  s.email       = ["david@academia.edu"]
+  s.homepage    = "https://github.com/academia-edu/redis_locks"
+  s.summary     = "Various locking utilities for Ruby using Redis"
+  s.description = "Various locking utilities for Ruby using Redis, including a mutex, a semaphore, and a token bucket rate limiter"
+  s.license     = "MIT"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "redis"
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
+end

data/spec/redis_locks/mutex_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe RedisLocks::Mutex do
+  let(:mutex) {
+    RedisLocks::Mutex.new(
+      'testmutex',
+      redis: $redis
+    )
+  }
+
+  it 'allows locking' do
+    expect(mutex.lock).to be_truthy
+  end
+
+  it 'allows locking via lock!' do
+    expect { mutex.lock! }.not_to raise_error
+  end
+
+  it 'runs block' do
+    ran = false
+    mutex.lock { ran = true }
+    expect(ran).to be_truthy
+  end
+
+  it 'runs two blocks successively' do
+    ran = 0
+    mutex.lock { ran += 1 }
+    mutex.lock { ran += 1 }
+    expect(ran).to eq(2)
+  end
+
+  context 'when locked' do
+    before do
+       mutex.lock!
+    end
+
+    it 'does not allow locking again' do
+      expect(mutex.lock).to be_falsey
+    end
+
+    it 'does not run block' do
+      ran = false
+      mutex.lock { ran = true }
+      expect(ran).to be_falsey
+    end
+
+    it 'raises error on lock!' do
+      expect { mutex.lock! }.to raise_error(RedisLocks::AlreadyLocked)
+    end
+
+    context 'and then unlocked' do
+      before do
+        mutex.unlock
+      end
+
+      it 'allows locking' do
+        expect(mutex.lock).to be_truthy
+      end
+    end
+  end
+end

data/spec/redis_locks/semaphore_spec.rb

@@ -0,0 +1,130 @@
+require 'spec_helper'
+
+describe RedisLocks::Semaphore do
+  context 'with one resource' do
+    let(:semaphore) {
+      RedisLocks::Semaphore.new(
+        'testsemaphore',
+        redis: $redis,
+        resources: 1
+      )
+    }
+
+    it 'allows locking' do
+      expect(semaphore.lock).to be_truthy
+    end
+
+    it 'allows locking via lock!' do
+      expect { semaphore.lock! }.not_to raise_error
+    end
+
+    it 'allows locking with timeout' do
+      expect(semaphore.lock timeout: 1).to be_truthy
+    end
+
+    it 'allows locking with infinite timeout' do
+      expect(semaphore.lock timeout: 0).to be_truthy
+    end
+
+    it 'runs block' do
+      ran = false
+      semaphore.lock { ran = true }
+      expect(ran).to be_truthy
+    end
+
+    it 'runs two blocks successively' do
+      ran = 0
+      semaphore.lock { ran += 1 }
+      semaphore.lock { ran += 1 }
+      expect(ran).to eq(2)
+    end
+
+    context 'when locked' do
+      before do
+        @token = semaphore.lock!
+      end
+
+      it 'does not allow locking again' do
+        expect(semaphore.lock).to be_falsey
+      end
+
+      it 'does not allow locking with timeout' do
+        expect(semaphore.lock timeout: 1).to be_falsey
+      end
+
+      it 'waits forever with infinite timeout' do
+        t = Thread.new do
+          semaphore.lock timeout: 0
+        end
+
+        sleep(2)
+        expect(t).to be_alive
+        t.kill
+      end
+
+      it 'does not run block' do
+        ran = false
+        semaphore.lock { ran = true }
+        expect(ran).to be_falsey
+      end
+
+      it 'raises error on lock!' do
+        expect { semaphore.lock! }.to raise_error(RedisLocks::SemaphoreUnavailable)
+      end
+
+      context 'and then unlocked' do
+        before do
+          semaphore.unlock @token
+        end
+
+        it 'allows locking' do
+          expect(semaphore.lock).to be_truthy
+        end
+      end
+    end
+  end
+
+  context 'with two resources' do
+    let(:semaphore) {
+      RedisLocks::Semaphore.new(
+        'testsem',
+        redis: $redis,
+        resources: 2
+      )
+    }
+
+    it 'allows locking' do
+      expect(semaphore.lock).to be_truthy
+    end
+
+    context 'after one lock' do
+      before do
+        @token = semaphore.lock
+      end
+
+      it 'allows locking again' do
+        expect(semaphore.lock).to be_truthy
+      end
+
+      context 'after another lock' do
+        before do
+          semaphore.lock
+        end
+
+        it 'does not allow locking a third time' do
+          expect(semaphore.lock).to be_falsey
+        end
+
+        context 'after releasing first lock' do
+          before do
+            semaphore.unlock @token
+          end
+
+          it 'allows locking' do
+            expect(semaphore.lock).to be_truthy
+          end
+        end
+      end
+    end
+  end
+end

data/spec/redis_locks/token_bucket_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe RedisLocks::TokenBucket do
+  context 'with two tokens per each two seconds' do
+    let(:bucket) {
+      RedisLocks::TokenBucket.new(
+        "testbucket",
+        redis: $redis,
+        period: 2,
+        number: 2
+      )
+    }
+
+    it 'allows resource to be used' do
+      expect(bucket.take).to be_truthy
+    end
+
+    it 'allows resource to be used via take!' do
+      expect { bucket.take! }.not_to raise_error
+    end
+
+    context 'with one resource used' do
+      before do
+        bucket.take!
+      end
+
+      it 'allows another resource to be used' do
+        expect(bucket.take).to be_truthy
+      end
+    end
+
+    context 'with all resources used' do
+      before do
+        # three rather than two because the microseconds since the first
+        # execution will allow another token to become available
+        3.times { bucket.take! }
+      end
+
+      it 'does not allow another resource to be used' do
+        expect(bucket.take).to be_falsey
+      end
+
+      it 'raises error on take!' do
+        expect { bucket.take! }.to raise_error(RedisLocks::RateLimitExceeded)
+      end
+
+      context 'after waiting' do
+        before do
+          sleep(2)
+        end
+
+        it 'allows another resource to be taken' do
+          expect(bucket.take).to be_truthy
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'pry'
+require 'redis'
+require 'redis_locks'
+require 'thread'
+
+$redis = Redis.new(db: ENV['REDIS_LOCKS_SPEC_DB'] || 15)
+
+raise "#{$redis.inspect} is non-empty!" if $redis.keys.any?
+
+RSpec.configure do |config|
+  config.after(:each) do
+    $redis.flushdb
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: redis_locks
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Academia.edu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Various locking utilities for Ruby using Redis, including a mutex, a
+  semaphore, and a token bucket rate limiter
+email:
+- david@academia.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/redis_locks.rb
+- lib/redis_locks/evalsha_or_eval.rb
+- lib/redis_locks/mutex.rb
+- lib/redis_locks/resource_unavailable.rb
+- lib/redis_locks/semaphore.rb
+- lib/redis_locks/token_bucket.rb
+- lib/redis_locks/version.rb
+- redis_locks.gemspec
+- spec/redis_locks/mutex_spec.rb
+- spec/redis_locks/semaphore_spec.rb
+- spec/redis_locks/token_bucket_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/academia-edu/redis_locks
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Various locking utilities for Ruby using Redis
+test_files:
+- spec/redis_locks/mutex_spec.rb
+- spec/redis_locks/semaphore_spec.rb
+- spec/redis_locks/token_bucket_spec.rb
+- spec/spec_helper.rb
+has_rdoc: