dalli-rate_limiter 0.1.0 → 0.1.1

data/README.md

@@ -1,4 +1,4 @@
-# Dalli::RateLimiter [![Build Status](https://travis-ci.org/mwpastore/dalli-rate_limiter.svg?branch=master)](https://travis-ci.org/mwpastore/dalli-rate_limiter)
+# Dalli::RateLimiter [![Build Status](https://travis-ci.org/mwpastore/dalli-rate_limiter.svg?branch=master)](https://travis-ci.org/mwpastore/dalli-rate_limiter) [![Gem Version](https://badge.fury.io/rb/dalli-rate_limiter.svg)](https://badge.fury.io/rb/dalli-rate_limiter)
 
 **Dalli::RateLimiter** provides arbitrary [Memcached][6]-backed rate limiting
 for your Ruby applications. You may be using an application-level rate limiter
@@ -48,17 +48,19 @@ Or install it yourself as:
 ## Basic Usage
 
 ```ruby
-lim = Dalli::RateLimiter.new
+def do_foo
+  lim = Dalli::RateLimiter.new
+
+  if lim.exceeded? "foo"
+    fail "Sorry, can't foo right now. Try again later!"
+  end
 
-if lim.exceeded? "foo"
-  fail "Sorry, can't foo right now. Try again later!"
-else
   # ..
 end
 ```
 
-**Dalli::RateLimiter** will, by default, create a ConnectionPool with the
-default options, using a block that yields Dalli::Client instances with the
+**Dalli::RateLimiter** will, by default, create a ConnectionPool with its
+default options, using a block that yields Dalli::Client instances with its
 default options. If `MEMCACHE_SERVERS` is set in your environment, or if your
 Memcached instance is running on localhost, port 11211, this is the quickest
 way to get started. Alternatively, you can pass in your own single-threaded
@@ -81,18 +83,21 @@ will definitely want to use either the default ConnectionPool or your own (as
 opposed to a single-threaded Dalli::Client instance).
 
 The main instance method, `#exceeded?` will return a falsy value if the request
-is free to proceed. If the limit has been exceeded, it will return a floating
-point value that represents the fractional number of seconds that the caller
-should wait until retrying the request. Assuming no other requests were process
-during that time, the retried request will be free to proceed at that point.
-When invoking this method, please be sure to pass in a key that is unique (in
-combination with the `:key_prefix` option described above) to the thing you are
-trying to limit. An optional second argument specifies the number of requests
-to "consume" from the allowance; this defaults to one (1). Please note that if
-the number of requests is greater than the maximum number of requests, it will
-never not be limited. Consider a limit of 50 requests per minute: no amount of
-waiting would allow for a batch of 51 requests! To help check for this, a
-public getter method `#max_requests` is available.
+is free to proceed. If the limit has been exceeded, it will return a positive
+floating point value that represents the fractional number of seconds that the
+caller should wait until retrying the request. Assuming no other requests were
+process during that time, the retried request will be free to proceed at that
+point.  When invoking this method, please be sure to pass in a key that is
+unique (in combination with the `:key_prefix` option described above) to the
+thing you are trying to limit. An optional second argument specifies the number
+of requests to "consume" from the allowance; this defaults to one (1).
+
+Please note that if the number of requests is greater than the maximum number
+of requests, the limit will never not be exceeded. Consider a limit of 50
+requests per minute: no amount of waiting would ever allow for a batch of 51
+requests! `#exceeded?` returns a negative integer in this event. To help detect
+this edge case proactively, a public getter method `#max_requests` is
+available.
 
 ## Advanced Usage
 
@@ -141,8 +146,9 @@ performance boost][8].
 
 A rate-limiting system is only as good as its backing store, and it should be
 noted that a Memcached ring can lose members or indeed its entire working set
-at the drop of a hat. Mission-critical use cases, where operations absolutely,
-positively have to be idempotent, should probably seek solutions elsewhere.
+(in the event of a flush operation) at the drop of a hat. Mission-critical use
+cases, where repeated operations absolutely, positively have to be restricted,
+should probably seek solutions elsewhere.
 
 The limiting algorithm seems to work well but it is far from battle-tested. I
 tried to use atomic operations where possible to mitigate race conditions, but

data/lib/dalli/rate_limiter.rb

@@ -28,17 +28,17 @@ module Dalli
     def exceeded?(unique_key, to_consume = 1)
       to_consume = to_ems(to_consume)
 
+      return -1 if to_consume > @max_requests
+
       timestamp_key = format_key(unique_key, "timestamp")
       allowance_key = format_key(unique_key, "allowance")
 
       @dalli.with do |dc|
-        if to_consume <= @max_requests
-          if dc.add(allowance_key, @max_requests - to_consume, @period, :raw => true)
-            # Short-circuit the simple case of seeing the key for the first time.
-            dc.set(timestamp_key, to_ems(Time.now.to_f), @period, :raw => true)
+        if dc.add(allowance_key, @max_requests - to_consume, @period, :raw => true)
+          # Short-circuit the simple case of seeing the key for the first time.
+          dc.set(timestamp_key, to_ems(Time.now.to_f), @period, :raw => true)
 
-            return nil
-          end
+          return nil
         end
 
         lock = acquire_lock(dc, unique_key) if @locking

data/lib/dalli/rate_limiter/version.rb

@@ -1,5 +1,5 @@
 module Dalli
   class RateLimiter
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dalli-rate_limiter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-30 00:00:00.000000000 Z
+date: 2016-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dalli
@@ -165,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 717744935584309687
+      hash: 132983352658914105
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23.2