Documented the options for Rack::Throttle::Limiter.new.

leereilly · Mar 21, 2010 · 8be3543 · 8be3543
1 parent b96ead3
commit 8be3543
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/lib/rack/throttle/interval.rb b/lib/rack/throttle/interval.rb
@@ -4,6 +4,14 @@ module Rack; module Throttle
   # minimum interval (by default, 1 second) between subsequent allowed HTTP
   # requests.
   class Interval < Limiter
+    ##
+    # @param  [#call]                  app
+    # @param  [Hash{Symbol => Object}] options
+    # @option options [Float] :min     (1.0)
+    def initialize(app, options = {})
+      super
+    end
+
     ##
     # Returns `true` if sufficient time (equal to or more than
     # {#minimum_interval}) has passed since the last request and the given

diff --git a/lib/rack/throttle/limiter.rb b/lib/rack/throttle/limiter.rb
@@ -6,8 +6,12 @@ class Limiter
     attr_reader :options
 
     ##
-    # @param  [#call]                  app
+    # @param  [#call]                      app
-    # @param  [Hash{Symbol => Object}] options
+    # @param  [Hash{Symbol => Object}]     options
+    # @option options [String] :cache      (Hash.new)
+    # @option options [String] :key        (nil)
+    # @option options [String] :key_prefix (nil)
+    # @option options [String] :message    ("Rate Limit Exceeded")
     def initialize(app, options = {})
       @app, @options = app, options
     end