resque-throttle 0.0.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) 2010 Zendesk
+
+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,17 @@
+= resque-throttle
+
+Description goes here.
+
+== 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 Zendesk. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "resque-throttle"
+    gem.summary = %Q{resque-throttle is an extension to the resque queue system that restricts the frequency in which certain jobs are run.}
+    gem.description = %Q{resque-throttle is an extension to the resque queue system that restricts the frequency in which certain jobs are run. Add more description here.}
+    gem.email = "scott@zendesk.com"
+    gem.homepage = "http://github.com/zendesk/resque-throttle"
+    gem.authors = ["scotttam"]
+    gem.add_dependency "resque", ">=1.4.0"
+    gem.add_development_dependency "thoughtbot-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 = "resque-throttle #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/init.rb

@@ -0,0 +1,2 @@
+require "resque/resque"
+require "resque/thottle"

data/lib/resque/resque.rb

@@ -0,0 +1,34 @@
+require "resque/throttle"
+
+module Resque
+  extend self
+
+  # Raised when trying to create a job that is throttled
+  class ThrottledError < RuntimeError; end
+      
+  def enqueue_with_throttle(klass, *args)
+    if should_throttle?(klass)
+      raise ThrottledError.new("#{klass} with key #{klass.key} has exceeded it's throttle limit")
+    end
+    enqueue_without_throttle(klass, *args)
+  end
+  alias_method :enqueue_without_throttle, :enqueue
+  alias_method :enqueue, :enqueue_with_throttle
+
+  private
+   
+  def should_throttle?(klass)
+    return false unless throttle_job?(klass)
+    
+    if redis.get(klass.key)
+      return true
+    else
+      redis.set(klass.key, true, klass.throttle)
+      return false
+    end
+  end
+
+  def throttle_job?(klass)
+    klass.ancestors.include?(Resque::ThrottledJob)  
+  end
+end

data/lib/resque/throttle.rb

@@ -0,0 +1,5 @@
+require 'resque'
+ 
+module Resque
+end
+

data/lib/resque/throttled_job.rb

@@ -0,0 +1,16 @@
+module Resque
+  class ThrottledJob < Job
+    
+    def self.identifier
+      nil
+    end
+    
+    def self.throttle
+      1800
+    end
+    
+    def self.key
+      [self.to_s, identifier].compact.join(":")
+    end
+  end
+end

data/resque-throttle.gemspec

@@ -0,0 +1,65 @@
+# 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{resque-throttle}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["scotttam"]
+  s.date = %q{2010-02-17}
+  s.description = %q{resque-throttle is an extension to the resque queue system that restricts the frequency in which certain jobs are run. Add more description here.}
+  s.email = %q{scott@zendesk.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/init.rb",
+     "lib/resque/resque.rb",
+     "lib/resque/throttle.rb",
+     "lib/resque/throttled_job.rb",
+     "resque-throttle.gemspec",
+     "test/resque/resque_test.rb",
+     "test/resque/throttled_job_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/zendesk/resque-throttle}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{resque-throttle is an extension to the resque queue system that restricts the frequency in which certain jobs are run.}
+  s.test_files = [
+    "test/resque/resque_test.rb",
+     "test/resque/throttled_job_test.rb",
+     "test/test_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_runtime_dependency(%q<resque>, [">= 1.4.0"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0.9.8"])
+    else
+      s.add_dependency(%q<resque>, [">= 1.4.0"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0.9.8"])
+    end
+  else
+    s.add_dependency(%q<resque>, [">= 1.4.0"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0.9.8"])
+  end
+end
+

data/test/resque/resque_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper.rb'
+
+class ResqueTest < Test::Unit::TestCase
+
+  context "Resque" do
+    setup do
+      Resque.redis.flush_all
+      assert_nil Resque.redis.get(OneHourThrottledJob.key)
+      @bogus_args = [1, 2]
+    end
+
+    context "#enqueue" do
+      should "add a throttled job key to the set with the proper TTL (Expire)" do
+        Resque.expects(:enqueue_without_throttle).returns(true) 
+        assert Resque.enqueue(OneHourThrottledJob, @bogus_args)
+        assert Resque.redis.get(OneHourThrottledJob.key)
+        assert_equal 3600, Resque.redis.ttl(OneHourThrottledJob.key)
+      end
+      
+      context "job has not reached throttle limit" do
+        should "not add another job to the queue and raise a throttled exception" do
+          Resque.expects(:enqueue_without_throttle).once
+          assert_raises(Resque::ThrottledError) { 2.times { Resque.enqueue(OneHourThrottledJob, @bogus_args) } }
+        end
+      end
+    end
+  end
+end

data/test/resque/throttled_job_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper.rb'
+
+class ThrottledJobTest < Test::Unit::TestCase
+ 
+  context "Resque::ThrottledJob" do 
+    should "instantiate a new Resque::ThrottledJob" do
+      assert Resque::ThrottledJob.new(:queue_name, OneHourThrottledJob)
+    end
+  
+    context "#throttle" do
+       should "return the number of seconds in which to throttle these jobs" do
+         assert_equal 3600, OneHourThrottledJob.throttle
+       end
+       
+       should "default to 30 minutes (1800 seconds) if not provided" do
+         assert_equal 1800, DefaultThrottledJob.throttle
+       end
+    end
+    
+    context "#identifier" do
+      should "return an additional key identifier used in storing the key in the redis SET" do
+        assert_equal "my_identifier", IdetifierThrottledJob.identifier
+      end
+      
+      should "return nil if not defined" do
+        assert_nil DefaultThrottledJob.identifier
+      end
+    end
+    
+    context "#key" do
+      should "consist of the class name and the identifier" do
+         assert_equal "IdetifierThrottledJob:my_identifier", IdetifierThrottledJob.key
+      end
+      
+      should "consist of just the class name if the identifier is not provided" do
+        assert_equal "DefaultThrottledJob", DefaultThrottledJob.key
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,43 @@
+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 'resque/resque'
+require 'resque/throttle'
+require 'resque/throttled_job'
+
+class Test::Unit::TestCase
+end
+
+#fixture classes
+class DefaultThrottledJob < Resque::ThrottledJob
+  @queue = :some_queue
+  
+  def self.perform(some_id, some_other_thing)
+  end
+end
+
+class OneHourThrottledJob < Resque::ThrottledJob
+  @queue = :some_queue
+
+  def self.throttle
+    3600
+  end
+  
+  def self.perform(some_id, some_other_thing)
+  end
+end
+
+class IdetifierThrottledJob < Resque::ThrottledJob
+  @queue = :some_queue
+
+  def self.identifier
+    "my_identifier"
+  end
+  
+  def self.perform(some_id, some_other_thing)
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: resque-throttle
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- scotttam
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-17 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: resque
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.0
+    version: 
+- !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: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.8
+    version: 
+description: resque-throttle is an extension to the resque queue system that restricts the frequency in which certain jobs are run. Add more description here.
+email: scott@zendesk.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/init.rb
+- lib/resque/resque.rb
+- lib/resque/throttle.rb
+- lib/resque/throttled_job.rb
+- resque-throttle.gemspec
+- test/resque/resque_test.rb
+- test/resque/throttled_job_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/zendesk/resque-throttle
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: resque-throttle is an extension to the resque queue system that restricts the frequency in which certain jobs are run.
+test_files: 
+- test/resque/resque_test.rb
+- test/resque/throttled_job_test.rb
+- test/test_helper.rb