fhwang-resque-throttle 0.3.0

data/.document

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

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+# Add dependencies required to use your gem here.
+gem 'resque', '>= 1.6.0'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "jeweler", "~> 1.5.2"
+  gem 'thoughtbot-shoulda', '>= 0'
+  gem 'mocha', '>= 0.9.8'
+end

data/Gemfile.lock

@@ -0,0 +1,34 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json (1.4.6)
+    mocha (0.9.12)
+    rack (1.2.1)
+    rake (0.8.7)
+    redis (2.0.10)
+    redis-namespace (0.8.0)
+      redis (< 3.0.0)
+    resque (1.10.0)
+      json (~> 1.4.6)
+      redis-namespace (~> 0.8.0)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    sinatra (1.0)
+      rack (>= 1.0)
+    thoughtbot-shoulda (2.11.1)
+    vegas (0.1.7)
+      rack (>= 1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler (~> 1.5.2)
+  mocha (>= 0.9.8)
+  resque (>= 1.6.0)
+  thoughtbot-shoulda

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.markdown

@@ -0,0 +1,66 @@
+resque-throttle
+===============
+
+Resque Throttle is a plugin for the [Resque][0] queueing system
+(http://github.com/defunkt/resque). It adds a ThrottledJob class that will
+limit the amount of times it can be enqueued per class. 
+
+To use
+------
+The job you wish to throttle should inherit from the Resque::ThrottledJob class.
+
+In your class, add the can_run_every in which the job should be throttled. Example:
+
+	class MyThrottledJob < Resque::ThrottledJob
+	  throttle :can_run_every => 24.hours
+
+	  #rest of your class here
+	end
+
+By default, the key which identifies the job is simply the class name. This "identifier"
+is stored in a redis key with a TTL equal to that of the can_run_every. Thus the 
+default behavior is a single Job class inheriting from Resque::ThrottledJob can only 
+run every 30 minutes. 
+
+If you'd like to override that to be more granular, you can do that in the identifier class method
+by returning a string. For example, if you want the job to be limited to once a day per
+account, do something like the following:
+
+	class MyThrottledJob < Resque::ThrottledJob
+	  throttle :can_run_every => 24.hours
+
+	  def self.identifier(*args)
+	    account_id = *args
+	    "account_id:#{account_id}"
+	  end
+
+	  #rest of your class here
+	end
+
+The *args passed to identifier are the same arguments that are passed to perform.
+
+When a job is throttled, it will raise a ThrottledError and the job will not be enqueued.
+
+Contributing
+------------
+
+Once you've made your commits:
+
+1. [Fork][1] Resque Throttle
+2. Create a topic branch - `git checkout -b my_branch`
+3. Push to your branch - `git push origin my_branch`
+4. Create an [Issue][2] with a link to your branch
+5. That's it!
+
+Author
+------
+Scott J. Tamosunas :: tamosunas@gmail.com :: @scotttam
+
+Copyright
+---------
+Copyright (c) 2010 Zendesk. See LICENSE for details.
+
+[0]: http://github.com/defunkt/resque
+[1]: http://help.github.com/forking/
+[2]: http://github.com/scotttam/resque-throttle/issues
+

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "fhwang-resque-throttle"
+  gem.homepage = "http://github.com/fhwang/resque-throttle"
+  gem.license = "MIT"
+  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.}
+  gem.email = "francis.hwang@profitably.com"
+  gem.authors = ["Francis Hwang"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fhwang-resque-throttle #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/lib/resque-throttle.rb

@@ -0,0 +1,3 @@
+require "resque/resque"
+require "resque/throttle"
+require "resque/throttled_job"

data/lib/resque/resque.rb

@@ -0,0 +1,40 @@
+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, *args)
+      unless klass.throttle_settings[:silent]
+        raise(
+          ThrottledError,
+          "#{klass} with key #{klass.key(*args)} has exceeded it's throttle limit"
+        )
+      end
+    else
+      enqueue_without_throttle(klass, *args)
+    end
+  end
+  alias_method :enqueue_without_throttle, :enqueue
+  alias_method :enqueue, :enqueue_with_throttle
+
+  private
+   
+  def should_throttle?(klass, *args)
+    return false if !throttle_job?(klass) || klass.disabled
+    return true if key_found?(klass, *args)
+    redis.setex(klass.key(*args), klass.can_run_every, true)
+    return false
+  end
+
+  def key_found?(klass, *args)
+     redis.get(klass.key(*args))
+  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,34 @@
+module Resque
+  class SettingNotFound < RuntimeError; end
+
+  class ThrottledJob
+
+    THROTTLE_DEFAULTS = {
+        :can_run_every => 1800,
+        :disabled      => false,
+    }
+
+    def self.throttle_settings
+      @throttle_settings ||= THROTTLE_DEFAULTS.dup
+    end
+
+    def self.throttle(args = {})
+      throttle_settings.merge!(args)
+    end
+
+    def self.identifier(*args)
+    end
+
+    def self.key(*args)
+      ['resque-throttle', self.to_s, identifier(*args)].compact.join(":")
+    end
+
+    def self.can_run_every
+      throttle_settings[:can_run_every]
+    end
+
+    def self.disabled
+      throttle_settings[:disabled]
+    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.2.19"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Scott J. Tamosunas"]
+  s.date = %q{2010-03-10}
+  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{tamosunas@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/resque-throttle.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/scotttam/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.6.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.6.0"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0.9.8"])
+    end
+  else
+    s.add_dependency(%q<resque>, [">= 1.6.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,42 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class ResqueTest < Test::Unit::TestCase
+
+  context "Resque" do
+    setup do
+      Resque.redis.flushall
+      assert_nil Resque.redis.get(OneHourThrottledJob.key)
+      @bogus_args = "bogus_arg"
+    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(IdentifierThrottledJob, @bogus_args)
+        assert(
+          Resque.redis.keys('*').include?(
+            "resque-throttle:IdentifierThrottledJob:my_bogus_arg"
+          )
+        )
+        assert_equal 3600, Resque.redis.ttl(IdentifierThrottledJob.key(@bogus_args))
+      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
+
+      should "enqueue a job without throttling if the job is disabled" do
+        Resque.expects(:enqueue_without_throttle).twice
+        2.times { Resque.enqueue(DisabledThrottledJob, @bogus_args) }
+      end
+      
+      should "silently throttle a job if that's how resque-throttle is configured" do
+        Resque.expects(:enqueue_without_throttle).once
+        2.times { Resque.enqueue(SilentThrottledJob, @bogus_args) }
+      end
+    end
+  end
+end

data/test/resque/throttled_job_test.rb

@@ -0,0 +1,57 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class ThrottledJobTest < Test::Unit::TestCase
+
+  context "Resque::ThrottledJob" do
+    should "instantiate a new Resque::ThrottledJob" do
+      assert Resque::ThrottledJob.new
+    end
+
+    context "settings" do
+      context "#can_run_every" do
+        should "return the number of seconds in which to throttle these jobs" do
+          assert_equal 3600, OneHourThrottledJob.can_run_every
+        end
+
+        should "default to 30 minutes (1800 seconds) if not provided" do
+          assert_equal 1800, DefaultThrottledJob.can_run_every
+        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", IdentifierThrottledJob.identifier("identifier")
+        end
+
+        should "return nil if not defined" do
+          assert_nil DefaultThrottledJob.identifier
+        end
+      end
+
+      context "#disabled" do
+        should "not be disabled by default" do
+          assert !DefaultThrottledJob.disabled
+        end
+
+        should "be able to be overriden" do
+          assert DisabledThrottledJob.disabled
+        end
+      end
+    end
+
+    context "#key" do
+      should "consist of a prefix, the class name and the identifier" do
+        assert_equal(
+          "resque-throttle:IdentifierThrottledJob:my_identifier", 
+          IdentifierThrottledJob.key("identifier")
+        )
+      end
+
+      should "consist of just the module prefix and the class name if the identifier is not provided" do
+        assert_equal(
+          "resque-throttle:DefaultThrottledJob", DefaultThrottledJob.key
+        )
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,59 @@
+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
+  throttle :can_run_every => 3600
+
+  def self.perform(some_id, some_other_thing)
+  end
+end
+
+class IdentifierThrottledJob < Resque::ThrottledJob
+  @queue = :some_queue
+
+  throttle :can_run_every => 3600
+
+  def self.perform(some_id, some_other_thing)
+  end
+  
+  def self.identifier(*args)
+    first, second = *args
+    "my_#{first}"
+  end
+end
+
+class DisabledThrottledJob < Resque::ThrottledJob
+  @queue = :some_queue
+  throttle :disabled => true
+
+  def self.perform(some_id, some_other_thing)
+  end
+end
+
+class SilentThrottledJob < Resque::ThrottledJob
+  @queue = :some_queue
+  throttle :silent => true
+  
+  def self.perform(some_id, some_other_thing)
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification 
+name: fhwang-resque-throttle
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
+platform: ruby
+authors: 
+- Francis Hwang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-17 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  type: :runtime
+  name: resque
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  name: jeweler
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: thoughtbot-shoulda
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  type: :development
+  name: mocha
+  prerelease: false
+  version_requirements: *id004
+description: resque-throttle is an extension to the resque queue system that restricts the frequency in which certain jobs are run.
+email: francis.hwang@profitably.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/resque-throttle.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/fhwang/resque-throttle
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+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: 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