sinatra-rate-limiter 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2eb98d3fb4708f2dde94dc7aa8fac5e790eea55
-  data.tar.gz: eff8f03476da900eff856f94b20989608cd07c1d
+  metadata.gz: 3442a4980f8b129023849abb927d12628d3264a2
+  data.tar.gz: f2a4160d6df1e036eb16d214fff7a05c6fa23705
 SHA512:
-  metadata.gz: cc4c520d384178af38c646dd55aedfcf08ee89d96a464825b4c26f3ddc66e3084e9a0a2831d2e68772073c75dd583b97636acb9a29b0fd96aec670ba2c22661b
-  data.tar.gz: 409c06eefea02caf1cea1c6a7b8a5fa662abaa7647a11660011c6a30e2c5ff2fada3e04e8f565a6e5f75e3e5452353922476b1bf4d2c4e1e2b568d07a996cb26
+  metadata.gz: 014e4148653366b3bb5bdfd8bfe42f378688c13803dbeacfa80a5ba88b9485377f2cb9fe1da7f68c9f799c40411ca43822db32b370ef48971ba62a7c3e91e3bb
+  data.tar.gz: ba1a7361fc46fe41d97ca057ffce1ac547ad49d456ea8b25760dd49a2baeed9b747b65a61c7b8d71e332020a66e66194978202298821f9c16fa2a2ed5de5d201

data/README.md

@@ -52,7 +52,7 @@ Use `rate_limit` in the pipeline of any route (i.e. in the route itself, or
 in a `before` filter, or in a Padrino controller, etc. `rate_limit` takes
 zero to infinite parameters, with the syntax:
 
-  ```
+  ```ruby
   rate_limit [BucketName], [[<Requests>, <Seconds>], ...], [[<Key>: <Value>], ...]
   ```
 
@@ -67,11 +67,10 @@ See the _Examples_ section below for usage examples.
 
 When a rate limit is exceeded, the exception `Sinatra::RateLimiter::Exceeded`
 is thrown. By default, this sends an response code `429` with a simple plain
-text error message. You can use Sinatra's error handling to customise this.
-
-E.g.:
+text error message. You can use Sinatra's error handling to customise this,
+for example to provide a JSON response with status code 400:
 
-  ```
+  ```ruby
   error Sinatra::RateLimiter::Exceeded do
     status 400
     content_type :json
@@ -82,11 +81,12 @@ E.g.:
 
 As well as the default error message being available in
 `env['sinatra.error'].message`, `the env['sinatra.error.rate_limiter']`
-object contains three values for the exceeded limit:
+object contains four values for the exceeded limit:
 
  * `.requests` Integer of the number of requests allowed
  * `.seconds` Integer of the number of seconds the request limit applies to
  * `.try_again` Integer the number of seconds until the limit resets
+ * `.bucket` Name of the triggering bucket
 
 ## Configuration
 

data/lib/sinatra/rate-limiter.rb

@@ -56,7 +56,7 @@ module Sinatra
           when :header_prefix
             raise ArgumentError, 'header_prefix must be a String' if value.class != String
           when :identifier
-            raise ArgumentError, 'identifier must be a Proc or nil' if (!value.nil? and value.class != Proc)
+            raise ArgumentError, 'identifier must be a Proc' if value.class != Proc
           else
             raise ArgumentError, "Invalid option #{option}"
           end
@@ -96,99 +96,91 @@ module Sinatra
       end
     end
 
-  end
+    class RateLimit
+      attr_accessor :settings, :request, :options
 
-  class RateLimit
-    attr_accessor :settings, :request, :options
+      def initialize(bucket, limits)
+        @bucket      = bucket
+        @limits      = limits
+        @time_prefix = get_min_time_prefix(@limits)
+      end
 
-    def initialize(bucket, limits)
-      @bucket        = bucket
-      @limits        = limits
-      @time_prefix   = get_min_time_prefix(@limits)
-    end
+      def options=(options)
+        options = settings.rate_limiter_default_options.merge(options)
+        @options = Struct.new(*options.keys).new(*options.values)
+      end
 
-    def options=(options)
-      options = settings.rate_limiter_default_options.merge(options)
-      @options = Struct.new(*options.keys).new(*options.values)
-    end
+      def identifier
+        @identifier ||= @options.identifier.call(request)
+      end
 
-    def history(seconds=0)
-      redis_history.select{|t| seconds.eql?(0) ? true : t > (Time.now.to_f - seconds)}
-    end
+      def history(seconds=0)
+        redis_history.select{|t| seconds.eql?(0) ? true : t > (Time.now.to_f - seconds)}
+      end
+
+      def headers
+        headers = []
 
-    def headers
-      headers = []
+        header_prefix = @options.header_prefix + (@bucket.eql?('default') ? '' : '-' + @bucket)
+        limit_no = 0 if @limits.length > 1
+        @limits.each do |limit|
+          limit_no = limit_no + 1 if limit_no
+          headers << [header_prefix + (limit_no ? "-#{limit_no}" : '') + '-Limit',     limit[:requests]]
+          headers << [header_prefix + (limit_no ? "-#{limit_no}" : '') + '-Remaining', limit_remaining(limit)]
+          headers << [header_prefix + (limit_no ? "-#{limit_no}" : '') + '-Reset',     limit_reset(limit)]
+        end
 
-      header_prefix = @options.header_prefix + (@bucket.eql?('default') ? '' : '-' + @bucket)
-      limit_no = 0 if @limits.length > 1
-      @limits.each do |limit|
-        limit_no = limit_no + 1 if limit_no
-        headers << [header_prefix + (limit_no ? "-#{limit_no}" : '') + '-Limit',     limit[:requests]]
-        headers << [header_prefix + (limit_no ? "-#{limit_no}" : '') + '-Remaining', limit_remaining(limit)]
-        headers << [header_prefix + (limit_no ? "-#{limit_no}" : '') + '-Reset',     limit_reset(limit)]
+        return headers
       end
 
-      return headers
-    end
+      def limit_remaining(limit)
+        limit[:requests] - history(limit[:seconds]).length
+      end
 
-   def limit_remaining(limit)
-      limit[:requests] - history(limit[:seconds]).length
-    end
+      def limit_reset(limit)
+        limit[:seconds] - (Time.now.to_f - history(limit[:seconds]).first.to_f).to_i
+      end
 
-    def limit_reset(limit)
-      limit[:seconds] - (Time.now.to_f - history(limit[:seconds]).first.to_f).to_i
-    end
+      def limits_exceeded?
+        exceeded = @limits.select {|limit| limit_remaining(limit) < 1}.sort_by{|e| e[:seconds]}.last
 
-    def limits_exceeded?
-      exceeded = @limits.select {|limit| limit_remaining(limit) < 1}.sort_by{|e| e[:seconds]}.last
+        if exceeded
+          try_again = limit_reset(exceeded)
+          return exceeded.merge({try_again: try_again.to_i, bucket: @bucket})
+        end
+      end
 
-      if exceeded
-        try_again = limit_reset(exceeded)
-        return exceeded.merge({try_again: try_again.to_i, bucket: @bucket})
+      def log_request
+        redis.setex(
+          [namespace, identifier, @bucket, Time.now.to_f.to_s].join('/'),
+          @settings.rate_limiter_redis_expires,
+          nil)
       end
-    end
 
-    def log_request
-      redis.setex(
-        [namespace, user_identifier, @bucket, Time.now.to_f.to_s].join('/'),
-        @settings.rate_limiter_redis_expires,
-        nil)
-    end
+      private
 
-    private
+      def redis_history
+        @history ||= redis.
+          keys("#{[namespace,identifier,@bucket].join('/')}/#{@time_prefix}*").
+          map{|k| k.split('/')[3].to_f}
+      end
 
-    def redis_history
-      if @history
-        @history
-      else
-        @history = redis.
-          keys("#{[namespace,user_identifier,@bucket].join('/')}/#{@time_prefix}*").
-        map{|k| k.split('/')[3].to_f}
+      def redis
+        @settings.rate_limiter_redis_conn
       end
-    end
 
-    def user_identifier
-      if @options.identifier.class == Proc
-        return @options.identifier.call(request)
-      else
-        return request.ip
+      def namespace
+        @settings.rate_limiter_redis_namespace
       end
-    end
 
-    def redis
-      @settings.rate_limiter_redis_conn
-    end
+      def get_min_time_prefix(limits)
+        now    = Time.now.to_f
+        oldest = Time.now.to_f - limits.sort_by{|l| -l[:seconds]}.first[:seconds]
 
-    def namespace
-      @settings.rate_limiter_redis_namespace
+        return now.to_s[0..((now/oldest).to_s.split(/^1\.|[1-9]+/)[1].length)].to_i.to_s
+      end
     end
 
-    def get_min_time_prefix(limits)
-      now    = Time.now.to_f
-      oldest = Time.now.to_f - limits.sort_by{|l| -l[:seconds]}.first[:seconds]
-
-      return now.to_s[0..((now/oldest).to_s.split(/^1\.|[1-9]+/)[1].length)].to_i.to_s
-    end
   end
 
   register RateLimiter

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-rate-limiter
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Warren Guy