prop 0.3.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Morten Primdahl
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,68 @@
+
+= Prop
+
+Prop is a simple gem for rate limiting requests of any kind. It allows you to configure hooks for registering certain actions, such that you can define thresholds, register usage and finally act on exceptions once thresholds get exceeded.
+
+To get going with Prop you first define the read and write operations. These define how you write a registered request and how to read the number of requests for a given action. For example do something like the below in a Rails initializer:
+
+  Prop.read do |key|
+    Rails.cache.read(key)
+  end
+
+  Prop.write do |key, value|
+    Rails.cache.write(key, value)
+  end
+
+You can choose to rely on a database or Moneta or Redis or whatever you'd like to use for transient storage. Prop does not do any sort of clean up of its key space, so you would have to implement that manually should you be using anything but an LRU cache.
+
+Once the read and write operations are defined, you can optionally define some preconfigured default thresholds. If for example, you want to have a threshold on accepted emails per hour from a given user, you could define a threshold and interval (in seconds) for this like so:
+
+  Prop.setup(:mails_per_hour, :threshold => 100, :interval => 1.hour)
+
+This results in a the following methods being generated:
+
+  # Throws Prop::RateLimitExceededError if the threshold/interval has been reached
+  Prop.throttle_mails_per_hour!
+
+  # Returns true if the threshold/interval has been reached
+  Prop.throttle_mails_per_hour?
+
+  # Sets the counter to 0
+  Prop.reset_mails_per_hour
+
+In many cases you will want to tie a specific key to a defined throttle, for example you can scope the throttling to a specific sender rather than running a global "mails per hour" throttle:
+
+  Prop.throttle_mails_per_hour!(mail.from)
+
+If this method gets called more than "threshold" times within "interval in seconds" Prop throws a Prop::RateLimitExceededError. 
+
+You can chose to override the threshold for a given key:
+
+  Prop.mails_per_hour(mail.from, :threshold => account.mail_throttle_threshold)
+
+If you wish to reset a specific throttle, you can do that like so:
+
+  Prop.reset_mails_per_hour(mail.from)
+
+When the threshold are invoked without argument, the key is nil and as such a scope of its own.
+
+Lastly you can use Prop without registering the thresholds up front:
+
+  Prop.throttle!(:key => 'nuisance@example.com', :threshold => 100, :interval -> 1.hour)
+  Prop.reset(:key => 'nuisance@example.com', :threshold => 100, :interval -> 1.hour)
+
+It's up to you to pass an appropriate key which reflects the scope you're rate limiting. The interval is tied to the underlying key generating mechanism, so if you change that between calls and have all other things equal, then that will result in different throttles being set.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Morten Primdahl. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "prop"
+    gem.summary = %Q{Puts a cork in their requests}
+    gem.description = %Q{A gem for implementing rate limiting}
+    gem.email = "morten@zendesk.com"
+    gem.homepage = "http://github.com/morten/prop"
+    gem.authors = ["Morten Primdahl"]
+    gem.add_development_dependency "shoulda", ">= 0"
+    gem.add_development_dependency "mocha", ">= 0.9.8"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "prop #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.1

data/lib/prop.rb

@@ -0,0 +1,83 @@
+require 'digest/md5'
+
+class Object
+  def define_prop_class_method(name, &blk)
+    (class << self; self; end).instance_eval { define_method(name, &blk) }
+  end
+end
+
+class Prop
+  class RateLimitExceededError < RuntimeError
+  end
+
+  class << self
+    attr_accessor :handles, :reader, :writer
+
+    def read(&blk)
+      self.reader = blk
+    end
+
+    def write(&blk)
+      self.writer = blk
+    end
+
+    def setup(handle, defaults)
+      raise RuntimeError.new("Invalid threshold setting") unless defaults[:threshold].to_i > 0
+      raise RuntimeError.new("Invalid interval setting") unless defaults[:interval].to_i > 0
+
+      define_prop_class_method "throttle_#{handle}!" do |*args|
+        throttle!(sanitized_prop_options(handle, args, defaults))
+      end
+
+      define_prop_class_method "throttle_#{handle}?" do |*args|
+        throttle?(sanitized_prop_options(handle, args, defaults))
+      end
+
+      define_prop_class_method "reset_#{handle}" do |*args|
+        reset(sanitized_prop_options(handle, args, defaults))
+      end
+    end
+
+    def throttle?(options)
+      cache_key = sanitized_prop_key(options)
+      reader.call(cache_key).to_i >= options[:threshold]
+    end
+
+    def throttle!(options)
+      cache_key = sanitized_prop_key(options)
+      counter   = reader.call(cache_key).to_i
+
+      if counter >= options[:threshold]
+        raise Prop::RateLimitExceededError.new("#{options[:key]} threshold #{options[:threshold]} exceeded")
+      else
+        writer.call(cache_key, counter + 1)
+      end
+    end
+
+    def reset(options)
+      cache_key = sanitized_prop_key(options)
+      writer.call(cache_key, 0)
+    end
+
+    def count(options)
+      cache_key = sanitized_prop_key(options)
+      reader.call(cache_key).to_i
+    end
+
+    private
+
+    def sanitized_prop_key(options)
+      cache_key = "#{options[:key]}/#{Time.now.to_i / options[:interval]}"
+      "prop/#{Digest::MD5.hexdigest(cache_key)}"
+    end
+    
+    def sanitized_prop_options(handle, args, defaults)
+      key  = handle.to_s
+      key << "/#{args.first}" if args.first
+
+      options = { :key => key, :threshold => defaults[:threshold].to_i, :interval => defaults[:interval].to_i }
+      options = options.merge(args.last) if args.last.is_a?(Hash)
+      options
+    end
+  end
+end

data/prop.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{prop}
+  s.version = "0.3.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Morten Primdahl"]
+  s.date = %q{2010-07-21}
+  s.description = %q{A gem for implementing rate limiting}
+  s.email = %q{morten@zendesk.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/prop.rb",
+     "prop.gemspec",
+     "test/helper.rb",
+     "test/test_prop.rb"
+  ]
+  s.homepage = %q{http://github.com/morten/prop}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Puts a cork in their requests}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_prop.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0.9.8"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0.9.8"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0.9.8"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'prop'
+
+class Test::Unit::TestCase
+end

data/test/test_prop.rb

@@ -0,0 +1,126 @@
+require 'helper'
+
+class TestProp < Test::Unit::TestCase
+
+  context "Prop" do
+    setup do
+      store = {}
+      Prop.read  { |key| store[key] }
+      Prop.write { |key, value| store[key] = value }
+
+      @start = Time.now
+      Time.stubs(:now).returns(@start)
+    end
+
+    context "#configure" do
+      should "raise errors on invalid configuation" do
+        assert_raises(RuntimeError) do
+          Prop.setup :hello_there, :threshold => 20, :interval => 'hello'
+        end
+
+        assert_raises(RuntimeError) do
+          Prop.setup :hello_there, :threshold => 'wibble', :interval => 100
+        end
+      end
+
+      should "accept a handle and an options hash" do
+        Prop.setup :hello_there, :threshold => 40, :interval => 100
+        assert Prop.respond_to?(:throttle_hello_there!)
+      end
+
+      should "result in a default handle" do
+        Prop.setup :hello_there, :threshold => 4, :interval => 10
+        4.times do |i|
+          assert_equal (i + 1), Prop.throttle_hello_there!('some key')
+        end
+
+        assert_raises(Prop::RateLimitExceededError) { Prop.throttle_hello_there!('some key') }
+        assert_equal 5, Prop.throttle_hello_there!('some key', :threshold => 20)
+      end
+
+      should "create a handle accepts integer keys" do
+        Prop.setup :hello_there, :threshold => 4, :interval => 10
+        assert Prop.throttle_hello_there!(5)
+      end
+
+      should "not shadow undefined methods" do
+        assert_raises(NoMethodError) { Prop.no_such_handle }
+      end
+    end
+
+    context "#reset" do
+      setup do
+        Prop.setup :hello, :threshold => 10, :interval => 10
+
+        5.times do |i|
+          assert_equal (i + 1), Prop.throttle_hello!
+        end
+      end
+
+      should "set the correct counter to 0" do
+        Prop.throttle_hello!('wibble')
+        Prop.throttle_hello!('wibble')
+
+        Prop.reset_hello
+        assert_equal 1, Prop.throttle_hello!
+
+        assert_equal 3, Prop.throttle_hello!('wibble')
+        Prop.reset_hello('wibble')
+        assert_equal 1, Prop.throttle_hello!('wibble')
+      end
+
+      should "be directly invokable" do
+        Prop.reset :key => :hello, :threshold => 10, :interval => 10
+        assert_equal 1, Prop.throttle_hello!
+      end
+    end
+
+    context "#throttle?" do
+      should "return true once the threshold has been reached" do
+        Prop.throttle!(:key => 'hello', :threshold => 2, :interval => 10)
+        assert !Prop.throttle?(:key => 'hello', :threshold => 2, :interval => 10)
+
+        Prop.throttle!(:key => 'hello', :threshold => 2, :interval => 10)
+        assert Prop.throttle?(:key => 'hello', :threshold => 2, :interval => 10)
+      end
+    end
+
+    context "#throttle!" do
+      should "increment counter correctly" do
+        3.times do |i|
+          assert_equal (i + 1), Prop.throttle!(:key => 'hello', :threshold => 10, :interval => 10)
+        end
+      end
+
+      should "reset counter when time window is passed" do
+        3.times do |i|
+          assert_equal (i + 1), Prop.throttle!(:key => 'hello', :threshold => 10, :interval => 10)
+        end
+
+        Time.stubs(:now).returns(@start + 20)
+
+        3.times do |i|
+          assert_equal (i + 1), Prop.throttle!(:key => 'hello', :threshold => 10, :interval => 10)
+        end
+      end
+
+      should "not increment the counter beyon the threshold" do
+        10.times do |i|
+          Prop.throttle!(:key => 'hello', :threshold => 5, :interval => 10) rescue nil
+        end
+
+        assert_equal 5, Prop.count(:key => 'hello', :threshold => 5, :interval => 10)
+      end
+
+      should "raise Prop::RateLimitExceededError when the threshold is exceeded" do
+        5.times do |i|
+          Prop.throttle!(:key => 'hello', :threshold => 5, :interval => 10)
+        end
+        assert_raises(Prop::RateLimitExceededError) do
+          Prop.throttle!(:key => 'hello', :threshold => 5, :interval => 10)
+        end
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: prop
+version: !ruby/object:Gem::Version 
+  hash: 17
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 1
+  version: 0.3.1
+platform: ruby
+authors: 
+- Morten Primdahl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-21 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  type: :development
+  version_requirements: *id002
+description: A gem for implementing rate limiting
+email: morten@zendesk.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/prop.rb
+- prop.gemspec
+- test/helper.rb
+- test/test_prop.rb
+has_rdoc: true
+homepage: http://github.com/morten/prop
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Puts a cork in their requests
+test_files: 
+- test/helper.rb
+- test/test_prop.rb