rate_limiter 0.0.2 → 0.0.3

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## v0.0.3
+
+* Added more if and unless conditions for rate limiting.
+* Added ability to enable or disable rate limiting on a controller or model.
+* Added RateLimiter source for determining the current user.
+
+## v0.0.2
+
+* RateLimiter.config.timestamp_field actually does something now.
+
 ## v0.0.1
 
 * Initial release.

data/lib/rate_limiter.rb

@@ -1,10 +1,27 @@
 require 'singleton'
 
 require 'rate_limiter/config'
+require 'rate_limiter/controller'
 require 'rate_limiter/model'
 
 module RateLimiter
-  def self.timestamp_field= field_name
+  def self.enabled=(value)
+    RateLimiter.config.enabled = value
+  end
+
+  def self.enabled?
+    !!RateLimiter.config.enabled
+  end
+
+  def self.enabled_for_controller=(value)
+    RateLimiter.store[:request_enabled_for_controller] = value
+  end
+
+  def self.enabled_for_controller?
+    !!RateLimiter.store[:request_enabled_for_controller]
+  end
+
+  def self.timestamp_field=(field_name)
     RateLimiter.config.timestamp_field = field_name
   end
 
@@ -12,8 +29,28 @@ module RateLimiter
     RateLimiter.config.timestamp_field
   end
 
+  def self.source=(value)
+    RateLimiter.store[:source] = value
+  end
+
+  def self.source
+    RateLimiter.store[:source]
+  end
+
+  def self.controller_info=(value)
+    RateLimiter.store[:controller_info] = value
+  end
+
+  def self.controller_info
+    RateLimiter.store[:controller_info]
+  end
+
   private
 
+  def self.store
+    Thread.current[:rate_limiter] || { :request_enabled_for_controller => true }
+  end
+
   def self.config
     @@config ||= RateLimiter::Config.instance
   end
@@ -22,3 +59,7 @@ end
 ActiveSupport.on_load(:active_record) do
   include RateLimiter::Model
 end
+
+ActiveSupport.on_load(:action_controller) do
+  include RateLimiter::Controller
+end

data/lib/rate_limiter/config.rb

@@ -1,9 +1,10 @@
 module RateLimiter
   class Config
     include Singleton
-    attr_accessor :timestamp_field
+    attr_accessor :enabled, :timestamp_field
 
     def initialize
+      @enabled         = true
       @timestamp_field = :created_at
     end
   end

data/lib/rate_limiter/controller.rb

@@ -0,0 +1,37 @@
+module RateLimiter
+  module Controller
+    def self.included(base)
+      base.before_filter :set_rate_limiter_source
+      base.before_filter :set_rate_limiter_controller_info
+      base.before_filter :set_rate_limiter_enabled_for_controller
+    end
+
+    protected
+
+    def user_for_rate_limiter
+      current_user rescue nil
+    end
+
+    def info_for_rate_limiter
+      {}
+    end
+
+    def rate_limiter_enabled_for_controller
+      true
+    end
+
+    private
+
+    def set_rate_limiter_source
+      ::RateLimiter.source = user_for_rate_limiter
+    end
+
+    def set_rate_limiter_controller_info
+      ::RateLimiter.controller_info = info_for_rate_limiter
+    end
+
+    def set_rate_limiter_enabled_for_controller
+      ::RateLimiter.enabled_for_controller = rate_limiter_enabled_for_controller
+    end
+  end
+end

data/lib/rate_limiter/model.rb

@@ -20,13 +20,24 @@ module RateLimiter
         class_attribute :rate_limit_unless_condition
         self.rate_limit_unless_condition = options[:unless]
 
+        class_attribute :rate_limit_enabled_for_model
+        self.rate_limit_enabled_for_model = true
+
+        def rate_limit_off
+          self.rate_limit_enabled_for_model = false
+        end
+
+        def rate_limit_on
+          self.rate_limit_enabled_for_model = true
+        end
+
         self.before_create :check_rate_limit
       end
     end
 
     module InstanceMethods
       def check_rate_limit
-        if rate_limit?
+        if switched_on? && rate_limit?
           klass = self.class
 
           others = klass.where("#{klass.rate_limit_on.to_s} = ? AND #{RateLimiter.config.timestamp_field.to_s} >= ?", self.send(klass.rate_limit_on), Time.now - klass.rate_limit_interval)
@@ -44,6 +55,10 @@ module RateLimiter
         end
       end
 
+      def switched_on?
+        RateLimiter.enabled? && RateLimiter.enabled_for_controller? && self.class.rate_limit_enabled_for_model
+      end
+
       def rate_limit?
         (rate_limit_if_condition.blank? || rate_limit_if_condition.call(self)) && !rate_limit_unless_condition.try(:call, self)
       end

data/lib/rate_limiter/version.rb

@@ -1,3 +1,3 @@
 module RateLimiter
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rate_limiter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-12 00:00:00.000000000 Z
+date: 2012-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -76,6 +76,7 @@ files:
 - Rakefile
 - lib/rate_limiter.rb
 - lib/rate_limiter/config.rb
+- lib/rate_limiter/controller.rb
 - lib/rate_limiter/model.rb
 - lib/rate_limiter/version.rb
 - rate_limiter.gemspec