gimme_a_break 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+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/Manifest

@@ -0,0 +1,6 @@
+MIT-LICENSE
+README.rdoc
+Rakefile
+init.rb
+lib/gimme_a_break.rb
+Manifest

data/README.rdoc

@@ -0,0 +1,51 @@
+= Gimme A Break
+
+This plugin adds a way to throttle ActiveRecord creation.
+
+Add +gimme_a_break+ to your model to enable the throttling.
+It will then not be possible to create models in quick succession.
+Object creation is usually very "expensive" (in time) and blocks most
+database servers. Database IO is usually the bottleneck
+in web applications, and thottling this back is a great way to
+increase overall availability.
+
+An error message will be added to the base object and the object
+will not be valid. It's up to you to display this error to the user.
+When you follow ActiveRecord convention you will be fine. The error
+message can be localized using the key <tt>gimme_a_break.notice</tt> with
+<tt>{{count}}</tt> as the timeout in seconds.
+
+The throttle is applied per running instance. If you have two Passenger
+instances running, people will be able to create twice the amount
+of objects. This is exactly what you want, since the limit should scale
+linearly with the capacity of your servers. If your database keeps
+getting overloaded, reduce the timeout.
+
+
+== Options
+
++timeout+: the time to wait between creates, in seconds. Default is 6.
+
+
+== Prerequisites
+
+Your model needs to have a created_at column for this to work.
+
+
+== Installation
+
+  ruby script/plugin install git://github.com/tilsammans/gimme_a_break
+
+
+== Examples
+
+  class Comment < ActiveRecord::Base
+    gimme_a_break
+  end
+
+  class Tweet < ActiveRecord::Base
+    gimme_a_break :timeout => 2
+  end
+
+
+Copyright (c) 2010 Joost Baaij, released under the MIT license

data/Rakefile

@@ -0,0 +1,12 @@
+require 'psych'
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('gimme_a_break', '0.1.0') do |p|
+  p.summary     = "Throttle ActiveRecord creation"
+  p.url         = "http://github.com/tilsammans/gimme_a_break"
+  p.author      = "Joost Baaij"
+  p.email       = "joost@spacebabies.nl"
+  p.development_dependencies = []
+end

data/gimme_a_break.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{gimme_a_break}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Joost Baaij}]
+  s.date = %q{2011-07-20}
+  s.description = %q{Throttle ActiveRecord creation}
+  s.email = %q{joost@spacebabies.nl}
+  s.extra_rdoc_files = [%q{README.rdoc}, %q{lib/gimme_a_break.rb}]
+  s.files = [%q{MIT-LICENSE}, %q{README.rdoc}, %q{Rakefile}, %q{init.rb}, %q{lib/gimme_a_break.rb}, %q{Manifest}, %q{gimme_a_break.gemspec}]
+  s.homepage = %q{http://github.com/tilsammans/gimme_a_break}
+  s.rdoc_options = [%q{--line-numbers}, %q{--inline-source}, %q{--title}, %q{Gimme_a_break}, %q{--main}, %q{README.rdoc}]
+  s.require_paths = [%q{lib}]
+  s.rubyforge_project = %q{gimme_a_break}
+  s.rubygems_version = %q{1.8.5}
+  s.summary = %q{Throttle ActiveRecord creation}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'gimme_a_break'

data/lib/gimme_a_break.rb

@@ -0,0 +1,30 @@
+# This plugin adds a way to throttle ActiveRecord creation.
+# Add +gimme_a_break+ to your model to enable the throttling.
+# It will then not be possible to create models in quick succession.
+# The error message will be added to the base object, and can be
+# localized using the key +gimme_a_break.notice+.
+module GimmeABreak
+  protected
+    def gimme_a_break
+      if last_created && last_created.created_at > self.class.gimme_a_break_timeout.seconds.ago
+        errors.add_to_base I18n.t("gimme_a_break.notice", :default => "Temporarily disabled due to a safety measure. Please try again in %{count} seconds", :count => self.class.gimme_a_break_timeout)
+      end
+    end
+    
+    def last_created
+      self.class.find(:first, :order => 'created_at desc')
+    end
+end
+
+# Reopening ActiveRecord::Base not bad, see http://yehudakatz.com/2009/11/12/better-ruby-idioms/
+class ActiveRecord::Base
+  def self.gimme_a_break(options ={})
+    cattr_accessor :gimme_a_break_timeout
+    self.gimme_a_break_timeout = (options[:timeout] || 6)
+    include GimmeABreak
+    
+    class_eval <<-EOV
+      validate :gimme_a_break
+    EOV
+  end
+end  

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: gimme_a_break
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Joost Baaij
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-20 00:00:00.000000000Z
+dependencies: []
+description: Throttle ActiveRecord creation
+email: joost@spacebabies.nl
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- lib/gimme_a_break.rb
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- init.rb
+- lib/gimme_a_break.rb
+- Manifest
+- gimme_a_break.gemspec
+homepage: http://github.com/tilsammans/gimme_a_break
+licenses: []
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- Gimme_a_break
+- --main
+- README.rdoc
+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: '1.2'
+requirements: []
+rubyforge_project: gimme_a_break
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Throttle ActiveRecord creation
+test_files: []