rate_limiter 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+pkg/*
+.DS_Store
+._*
+.idea/
+.redcar/

data/.rspec

@@ -0,0 +1,3 @@
+--tty
+--colour
+--format p

data/.rvmrc

@@ -0,0 +1,80 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
+environment_id="ruby-1.9.3-p327@rate_limiter"
+
+#
+# Uncomment the following lines if you want to verify rvm version per project
+#
+# rvmrc_rvm_version="1.10.2" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+#
+
+#
+# Uncomment following line if you want options to be set only for given project.
+#
+# PROJECT_JRUBY_OPTS=( --1.9 )
+#
+# The variable PROJECT_JRUBY_OPTS requires the following to be run in shell:
+#
+#    chmod +x ${rvm_path}/hooks/after_use_jruby_opts
+#
+
+#
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+#
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+
+  if [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]]
+  then
+    . "${rvm_path:-$HOME/.rvm}/hooks/after_use"
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  if ! rvm --create  "$environment_id"
+  then
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  fi
+fi
+
+#
+# If you use an RVM gemset file to install a list of gems (*.gems), you can have
+# it be automatically loaded. Uncomment the following and adjust the filename if
+# necessary.
+#
+# filename=".gems"
+# if [[ -s "$filename" ]]
+# then
+#   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
+# fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && ! command -v bundle >/dev/null
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && command -v bundle
+# then
+#   bundle install
+# fi
+
+if [[ $- == *i* ]] # check for interactive shells
+then
+    echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+else
+	echo "Using: $GEM_HOME" # don't use colors in interactive shells
+fi

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* Initial release.

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    rate_limiter (0.0.1)
+      activerecord (~> 3.0)
+      railties (~> 3.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (3.2.9)
+      activemodel (= 3.2.9)
+      activesupport (= 3.2.9)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.9)
+      activesupport (= 3.2.9)
+      builder (~> 3.0.0)
+    activerecord (3.2.9)
+      activemodel (= 3.2.9)
+      activesupport (= 3.2.9)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.9)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.1)
+    journey (1.0.4)
+    json (1.7.5)
+    multi_json (1.5.0)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    railties (3.2.9)
+      actionpack (= 3.2.9)
+      activesupport (= 3.2.9)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.0.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.1)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.16.0)
+    tilt (1.3.3)
+    tzinfo (0.3.35)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rate_limiter!
+  rspec

data/README.md

@@ -0,0 +1,65 @@
+# rate_limiter
+
+A gem that limits the rate at which ActiveRecord model instances can be created.
+
+## Rails Version
+
+This gem has only been tested on Rails 3.2. There is no reason that I am aware of that would prevent it from working on all versions of Rails 3 (and Rails 4 when it is released).
+
+## Installation
+
+Add the gem to your project's Gemfile:
+
+    gem 'rate_limiter'
+
+## Basic Usage
+
+In the models you want to rate limit simply call the `rate_limit` method inside the model.
+
+```ruby
+class ProductReview < ActiveRecord::Base
+  rate_limit
+end
+```
+
+By default this will rate limit creation of instances using the `ip_address` attribute with an interval of one minute. This is kind of a bold assumption (that may change in future versions) since there's a good chance you don't have an `ip_address` attribute on your model. If that's the case then you can do the following:
+
+```ruby
+class ProductReview < ActiveRecord::Base
+  rate_limit :on => :username
+end
+```
+
+This will instead check for `ProductReview`s with a matching `username` instead.
+
+Because you may want to increase or decrease the interval between creating instances of your model you can do this:
+
+```ruby
+class ProductReview < ActiveRecord::Base
+  rate_limit :interval => 3.hours
+end
+```
+
+## Contributing
+
+If you feel like you can add something useful to rate_limiter then don't hesitate to contribute! To make sure your fix/feature has a high chance of being included, please do the following:
+
+1. Fork the repo.
+
+2. Run the tests. I will only take pull requests with passing tests, and it's great to know that you have a clean slate: `bundle && rake`
+
+3. Add a test for your change. Only adding tests for existing code, refactoring, and documentation changes require no new tests. If you are adding functionality or fixing a bug, you need a test!
+
+4. Make the test pass.
+
+5. Push to your fork and submit a pull request.
+
+I can't guarantee that I will accept the change, but if I don't I will be sure to let you know why!
+
+Some things that will increase the chance that your pull request is accepted, taken straight from the Ruby on Rails guide:
+
+* Use Rails idioms and helpers
+* Include tests that fail without your code, and pass with it
+* Update the documentation, guides, or whatever is affected by your contribution
+
+Yes, I am well aware of the irony of asking for tests when there are effectively none right now. This gem is a work in progress.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/rate_limiter.rb

@@ -0,0 +1,24 @@
+require 'singleton'
+
+require 'rate_limiter/config'
+require 'rate_limiter/model'
+
+module RateLimiter
+  def self.timestamp_field= field_name
+    RateLimiter.config.timestamp_field = field_name
+  end
+
+  def self.timestamp_field
+    RateLimiter.config.timestamp_field
+  end
+
+  private
+
+  def self.config
+    @@config ||= RateLimiter::Config.instance
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  include RateLimiter::Model
+end

data/lib/rate_limiter/config.rb

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

data/lib/rate_limiter/model.rb

@@ -0,0 +1,52 @@
+module RateLimiter
+  module Model
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    module ClassMethods
+      def rate_limit options = {}
+        send :include, InstanceMethods
+
+        class_attribute :rate_limit_on
+        self.rate_limit_on = options[:on] || :ip_address
+
+        class_attribute :rate_limit_interval
+        self.rate_limit_interval = options[:interval] || 1.minute
+
+        class_attribute :rate_limit_if_condition
+        self.rate_limit_if_condition = options[:if]
+
+        class_attribute :rate_limit_unless_condition
+        self.rate_limit_unless_condition = options[:unless]
+
+        self.before_create :check_rate_limit
+      end
+    end
+
+    module InstanceMethods
+      def check_rate_limit
+        if rate_limit?
+          klass = self.class
+
+          others = klass.where("#{klass.rate_limit_on} =? AND created_at >= ?", self.send(klass.rate_limit_on), Time.now - klass.rate_limit_interval)
+
+          if others.present?
+            # TODO: Come up with a better error message.
+            self.errors.add(:base, "You cannot create a new #{klass.name.downcase} yet.")
+
+            false
+          else
+            true
+          end
+        else
+          true
+        end
+      end
+
+      def rate_limit?
+        (rate_limit_if_condition.blank? || rate_limit_if_condition.call(self)) && !rate_limit_unless_condition.try(:call, self)
+      end
+    end
+  end
+end

data/lib/rate_limiter/version.rb

@@ -0,0 +1,3 @@
+module RateLimiter
+  VERSION = '0.0.1'
+end

data/rate_limiter.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'rate_limiter/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'rate_limiter'
+  s.version     = RateLimiter::VERSION
+  s.authors     = ['Sean Eshbaugh']
+  s.email       = ['seaneshbaugh@gmail.com']
+  s.homepage    = 'https://github.com/seaneshbaugh/rate_limiter'
+  s.summary     = 'Adds creation rate limiting to ActiveRecord models.'
+  s.description = 'Adds creation rate limiting to ActiveRecord models.'
+
+  s.rubyforge_project = 'rate_limiter'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'railties', '~> 3.0'
+  s.add_dependency 'activerecord', '~> 3.0'
+
+  s.add_development_dependency 'rspec'
+end

data/spec/rate_limiter/rate_limiter_spec.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+require 'spec_helper.rb'
+
+describe RateLimiter do
+  describe 'Sanity Test' do
+    it 'should be a Module' do
+      RateLimiter.should be_a(Module)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+require 'rails/railtie'
+require 'active_record'
+
+require 'rate_limiter'

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: rate_limiter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sean Eshbaugh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds creation rate limiting to ActiveRecord models.
+email:
+- seaneshbaugh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/rate_limiter.rb
+- lib/rate_limiter/config.rb
+- lib/rate_limiter/model.rb
+- lib/rate_limiter/version.rb
+- rate_limiter.gemspec
+- spec/rate_limiter/rate_limiter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/seaneshbaugh/rate_limiter
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: rate_limiter
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Adds creation rate limiting to ActiveRecord models.
+test_files:
+- spec/rate_limiter/rate_limiter_spec.rb
+- spec/spec_helper.rb