curbit 0.1.2 → 0.2.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+.document

data/README.rdoc

@@ -65,6 +65,24 @@ instance as an argument.
 because the Proc is not bound to the controller instance when it's
 defined.  This way, you can at least have access to stuff you might need.)
 
+=== Conditional rate limiting
+
+You may want to apply rate limiting only in certain conditions, for example, if 
+a user is authenticated.  Curbit provides the :if and :unless parameters that 
+both accept a symbol or Proc.  If a symbol is passed then Curbit attempts 
+to execute a method using the symbol as the method name.  In the case of the :if parameter, 
+the rate limit is applied if the method returns true.  For the :unless paramter, the rate 
+limit is not applied if the method returns true.
+
+    rate_limit :invite, 
+               :max_calls => 2,  
+               :time_limit => 30.seconds, 
+               :wait_time => 1.minute,
+               :unless => :logged_in?
+
+In this case, the rate limiting is being used with the acts_as_authenticated method logged_in?
+so that the rate limiting is only applied if the user is not logged in.
+
 === Custom message
 
 You might like to customize the messages returned by CurbIt.

data/Rakefile

@@ -53,3 +53,4 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/curbit.gemspec

@@ -1,31 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{curbit}
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Scott Sayles"]
-  s.date = %q{2009-10-25}
-  s.description = %q{Application level rate limiting for Rails}
+  s.date = %q{2010-01-26}
+  s.description = %q{Rate limiting for Rails action controllers.}
   s.email = %q{ssayles@users.sourceforge.net}
-  s.extra_rdoc_files = ["LICENSE", "README.rdoc", "lib/curbit.rb"]
-  s.files = ["LICENSE", "README.rdoc", "Rakefile", "init.rb", "lib/curbit.rb", "test/custom_key_controller_test.rb", "test/custom_message_format_controller.rb", "test/standard_controller_test.rb", "test/test_helper.rb", "test/test_rails_helper.rb", "Manifest", "curbit.gemspec"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "Manifest",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "curbit.gemspec",
+     "init.rb",
+     "lib/curbit.rb",
+     "test/conditional_controller_test.rb",
+     "test/custom_key_controller_test.rb",
+     "test/custom_message_format_controller.rb",
+     "test/standard_controller_test.rb",
+     "test/test_helper.rb",
+     "test/test_rails_helper.rb"
+  ]
   s.homepage = %q{http://github.com/ssayles/curbit}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Curbit", "--main", "README.rdoc"]
+  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubyforge_project = %q{curbit}
   s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Application level rate limiting for Rails}
-  s.test_files = ["test/custom_key_controller_test.rb", "test/standard_controller_test.rb", "test/test_helper.rb", "test/test_rails_helper.rb"]
+  s.summary = %q{Rate limiting for Rails action controllers.}
+  s.test_files = [
+    "test/conditional_controller_test.rb",
+     "test/custom_key_controller_test.rb",
+     "test/custom_message_format_controller.rb",
+     "test/standard_controller_test.rb",
+     "test/test_helper.rb",
+     "test/test_rails_helper.rb"
+  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
     else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
     end
   else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
   end
 end

data/lib/curbit.rb

@@ -20,6 +20,8 @@ module Curbit
       # * +wait_time+ - The time to wait if :max_calls has been reached before being able to pass.
       # * +message+ - The message to render to the client if the call is being limited.  The message will be rendered as a correspondingly formatted response with a default status if given a String.  If the argument is a symbol, a method with the same name will be invoked with the specified wait_time (in seconds).  The called method should take care of rendering the response.
       # * +status+ - The response status to set when the call is being limited.
+      # * +if+ - A symbol representing a method or Proc that returns true if the rate limiting should be applied.
+      # * +unless+ - A symbol representing a method or Proc that returns true if the rate limiting should NOT be applied.
       #
       # ==== Examples
       # 
@@ -64,6 +66,9 @@ module Curbit
       def rate_limit_opts_valid?(opts = {})
         new_opts = {:status => 503}.merge! opts
         opts.merge! new_opts
+        if opts.key?(:if) and opts.key?(:unless)
+          raise ":unless and :if are mutually exclusive parameters"
+        end
         if !opts.key?(:max_calls) or !opts.key?(:time_limit) or !opts.key?(:wait_time)
           raise ":max_calls, :time_limit, and :wait_time are required parameters"
         end
@@ -80,7 +85,28 @@ module Curbit
       "#{CacheKeyPrefix}_#{self.class.name}_#{method}_#{key}"
     end
 
+    def rate_limit_conditional(opts)
+      if opts.key?(:unless)
+       if opts[:unless].is_a? Proc
+         return true if opts[:unless].call(self)
+       elsif opts[:unless].is_a? Symbol
+         return true if self.send(opts[:unless])
+        end
+      end
+      if opts.key?(:if)
+       if opts[:if].is_a? Proc
+         return true unless opts[:if].call(self)
+       elsif opts[:if].is_a? Symbol
+         return true unless self.send(opts[:if])
+        end
+      end
+      return false
+    end
+
     def rate_limit_filter(method, opts)
+
+      return true if rate_limit_conditional(opts)
+
       key = get_key(opts[:key])
       unless (key)
         return true
@@ -97,6 +123,8 @@ module Curbit
         val[:count] = count + 1
         started_waiting = val[:started_waiting]
 
+        # did we start making the user wait before being allowed to make
+        # another call?
         if started_waiting
           # did we exceed the wait time?
           if Time.now.to_i > (started_waiting.to_i + opts[:wait_time])

data/test/conditional_controller_test.rb

@@ -0,0 +1,67 @@
+require 'test_helper'
+require 'test_rails_helper'
+
+class ConditionalController < ActionController::Base
+
+  include Curbit::Controller
+
+  attr_accessor :rendered
+
+  def index
+    render :text => 'index action'
+  end
+
+  def show
+    render :text => 'show action'
+  end
+
+  rate_limit :index, :max_calls => 2,
+                     :time_limit => 30.seconds,
+                     :wait_time => 2.minute,
+                     :if => :logged_in?
+
+  rate_limit :show,  :max_calls => 2,
+                     :time_limit => 30.seconds,
+                     :wait_time => 2.minute,
+                     :unless => :logged_in?
+
+
+  protected
+
+  def logged_in?
+    true
+  end
+
+end
+
+
+class ConditionalControllerTest < ActionController::TestCase
+  tests ConditionalController
+
+  context "When calling a rate limited method with " do
+    setup {
+      @env = {'HTTP_X_FORWARDED_FOR' => '192.168.1.123'}
+      @request.stubs(:env).returns(@env)
+      cache_value = {:started => Time.now.to_i - 15.seconds,
+                     :count => 2
+                     }
+      Rails.cache.stubs(:read).returns(cache_value)
+      Rails.cache.stubs(:write)
+    }
+    context ":if, it" do
+        should "should call a method named by the symbol" do
+          get :index
+          assert_equal "503 Service Unavailable", @response.status
+        end
+    end
+     context ":unless, it" do
+        should "should call a method named by the symbol" do
+          get :show
+          assert_equal "show action", @response.body
+        end
+    end
+   
+
+  end
+end
+

data/test/standard_controller_test.rb

@@ -86,11 +86,16 @@ class CurbiControllerTest < ActionController::TestCase
       }
       context "and max calls has been exceeded for the current time limit" do
         setup {
+          # emulate the state needed to indicate that we've started
+          # waiting on calls
           cache_value = {:started => Time.now.to_i - 15.seconds,
                          :count => 1
                          }
           Rails.cache.stubs(:read).returns(cache_value)
-          Rails.cache.stubs(:write)
+          Rails.cache.stubs(:write).with() {|key, val, duration|
+            cache_value[:count] = val[:count]
+            true;
+          }
         }
         context ", the call" do
           should "be blocked" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: curbit
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors: 
 - Scott Sayles
@@ -9,11 +9,20 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-25 00:00:00 -04:00
+date: 2010-01-26 00:00:00 -05:00
 default_executable: 
-dependencies: []
-
-description: Application level rate limiting for Rails
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Rate limiting for Rails action controllers.
 email: ssayles@users.sourceforge.net
 executables: []
 
@@ -22,32 +31,29 @@ extensions: []
 extra_rdoc_files: 
 - LICENSE
 - README.rdoc
-- lib/curbit.rb
 files: 
+- .gitignore
 - LICENSE
+- Manifest
 - README.rdoc
 - Rakefile
+- VERSION
+- curbit.gemspec
 - init.rb
 - lib/curbit.rb
+- test/conditional_controller_test.rb
 - test/custom_key_controller_test.rb
 - test/custom_message_format_controller.rb
 - test/standard_controller_test.rb
 - test/test_helper.rb
 - test/test_rails_helper.rb
-- Manifest
-- curbit.gemspec
 has_rdoc: true
 homepage: http://github.com/ssayles/curbit
 licenses: []
 
 post_install_message: 
 rdoc_options: 
-- --line-numbers
-- --inline-source
-- --title
-- Curbit
-- --main
-- README.rdoc
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -60,17 +66,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "1.2"
+      version: "0"
   version: 
 requirements: []
 
-rubyforge_project: curbit
+rubyforge_project: 
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Application level rate limiting for Rails
+summary: Rate limiting for Rails action controllers.
 test_files: 
+- test/conditional_controller_test.rb
 - test/custom_key_controller_test.rb
+- test/custom_message_format_controller.rb
 - test/standard_controller_test.rb
 - test/test_helper.rb
 - test/test_rails_helper.rb