resque-throttle 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.document +5 -0
- data/.gitignore +21 -0
- data/LICENSE +20 -0
- data/README.rdoc +17 -0
- data/Rakefile +55 -0
- data/VERSION +1 -0
- data/lib/init.rb +2 -0
- data/lib/resque/resque.rb +34 -0
- data/lib/resque/throttle.rb +5 -0
- data/lib/resque/throttled_job.rb +16 -0
- data/resque-throttle.gemspec +65 -0
- data/test/resque/resque_test.rb +28 -0
- data/test/resque/throttled_job_test.rb +40 -0
- data/test/test_helper.rb +43 -0
- metadata +100 -0
data/.document
ADDED
data/.gitignore
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
Copyright (c) 2010 Zendesk
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
4
|
+
a copy of this software and associated documentation files (the
|
5
|
+
"Software"), to deal in the Software without restriction, including
|
6
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
7
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
8
|
+
permit persons to whom the Software is furnished to do so, subject to
|
9
|
+
the following conditions:
|
10
|
+
|
11
|
+
The above copyright notice and this permission notice shall be
|
12
|
+
included in all copies or substantial portions of the Software.
|
13
|
+
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
15
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
16
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
17
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
18
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
19
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
20
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.rdoc
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
= resque-throttle
|
2
|
+
|
3
|
+
Description goes here.
|
4
|
+
|
5
|
+
== Note on Patches/Pull Requests
|
6
|
+
|
7
|
+
* Fork the project.
|
8
|
+
* Make your feature addition or bug fix.
|
9
|
+
* Add tests for it. This is important so I don't break it in a
|
10
|
+
future version unintentionally.
|
11
|
+
* Commit, do not mess with rakefile, version, or history.
|
12
|
+
(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)
|
13
|
+
* Send me a pull request. Bonus points for topic branches.
|
14
|
+
|
15
|
+
== Copyright
|
16
|
+
|
17
|
+
Copyright (c) 2010 Zendesk. See LICENSE for details.
|
data/Rakefile
ADDED
@@ -0,0 +1,55 @@
|
|
1
|
+
require 'rubygems'
|
2
|
+
require 'rake'
|
3
|
+
|
4
|
+
begin
|
5
|
+
require 'jeweler'
|
6
|
+
Jeweler::Tasks.new do |gem|
|
7
|
+
gem.name = "resque-throttle"
|
8
|
+
gem.summary = %Q{resque-throttle is an extension to the resque queue system that restricts the frequency in which certain jobs are run.}
|
9
|
+
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.}
|
10
|
+
gem.email = "scott@zendesk.com"
|
11
|
+
gem.homepage = "http://github.com/zendesk/resque-throttle"
|
12
|
+
gem.authors = ["scotttam"]
|
13
|
+
gem.add_dependency "resque", ">=1.4.0"
|
14
|
+
gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
|
15
|
+
gem.add_development_dependency "mocha", ">=0.9.8"
|
16
|
+
# gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
|
17
|
+
end
|
18
|
+
Jeweler::GemcutterTasks.new
|
19
|
+
rescue LoadError
|
20
|
+
puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
|
21
|
+
end
|
22
|
+
|
23
|
+
require 'rake/testtask'
|
24
|
+
Rake::TestTask.new(:test) do |test|
|
25
|
+
test.libs << 'lib' << 'test'
|
26
|
+
test.pattern = 'test/**/test_*.rb'
|
27
|
+
test.verbose = true
|
28
|
+
end
|
29
|
+
|
30
|
+
begin
|
31
|
+
require 'rcov/rcovtask'
|
32
|
+
Rcov::RcovTask.new do |test|
|
33
|
+
test.libs << 'test'
|
34
|
+
test.pattern = 'test/**/test_*.rb'
|
35
|
+
test.verbose = true
|
36
|
+
end
|
37
|
+
rescue LoadError
|
38
|
+
task :rcov do
|
39
|
+
abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
|
40
|
+
end
|
41
|
+
end
|
42
|
+
|
43
|
+
task :test => :check_dependencies
|
44
|
+
|
45
|
+
task :default => :test
|
46
|
+
|
47
|
+
require 'rake/rdoctask'
|
48
|
+
Rake::RDocTask.new do |rdoc|
|
49
|
+
version = File.exist?('VERSION') ? File.read('VERSION') : ""
|
50
|
+
|
51
|
+
rdoc.rdoc_dir = 'rdoc'
|
52
|
+
rdoc.title = "resque-throttle #{version}"
|
53
|
+
rdoc.rdoc_files.include('README*')
|
54
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
55
|
+
end
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
0.0.1
|
data/lib/init.rb
ADDED
@@ -0,0 +1,34 @@
|
|
1
|
+
require "resque/throttle"
|
2
|
+
|
3
|
+
module Resque
|
4
|
+
extend self
|
5
|
+
|
6
|
+
# Raised when trying to create a job that is throttled
|
7
|
+
class ThrottledError < RuntimeError; end
|
8
|
+
|
9
|
+
def enqueue_with_throttle(klass, *args)
|
10
|
+
if should_throttle?(klass)
|
11
|
+
raise ThrottledError.new("#{klass} with key #{klass.key} has exceeded it's throttle limit")
|
12
|
+
end
|
13
|
+
enqueue_without_throttle(klass, *args)
|
14
|
+
end
|
15
|
+
alias_method :enqueue_without_throttle, :enqueue
|
16
|
+
alias_method :enqueue, :enqueue_with_throttle
|
17
|
+
|
18
|
+
private
|
19
|
+
|
20
|
+
def should_throttle?(klass)
|
21
|
+
return false unless throttle_job?(klass)
|
22
|
+
|
23
|
+
if redis.get(klass.key)
|
24
|
+
return true
|
25
|
+
else
|
26
|
+
redis.set(klass.key, true, klass.throttle)
|
27
|
+
return false
|
28
|
+
end
|
29
|
+
end
|
30
|
+
|
31
|
+
def throttle_job?(klass)
|
32
|
+
klass.ancestors.include?(Resque::ThrottledJob)
|
33
|
+
end
|
34
|
+
end
|
@@ -0,0 +1,65 @@
|
|
1
|
+
# Generated by jeweler
|
2
|
+
# DO NOT EDIT THIS FILE DIRECTLY
|
3
|
+
# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
|
4
|
+
# -*- encoding: utf-8 -*-
|
5
|
+
|
6
|
+
Gem::Specification.new do |s|
|
7
|
+
s.name = %q{resque-throttle}
|
8
|
+
s.version = "0.0.1"
|
9
|
+
|
10
|
+
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
|
11
|
+
s.authors = ["scotttam"]
|
12
|
+
s.date = %q{2010-02-17}
|
13
|
+
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.}
|
14
|
+
s.email = %q{scott@zendesk.com}
|
15
|
+
s.extra_rdoc_files = [
|
16
|
+
"LICENSE",
|
17
|
+
"README.rdoc"
|
18
|
+
]
|
19
|
+
s.files = [
|
20
|
+
".document",
|
21
|
+
".gitignore",
|
22
|
+
"LICENSE",
|
23
|
+
"README.rdoc",
|
24
|
+
"Rakefile",
|
25
|
+
"VERSION",
|
26
|
+
"lib/init.rb",
|
27
|
+
"lib/resque/resque.rb",
|
28
|
+
"lib/resque/throttle.rb",
|
29
|
+
"lib/resque/throttled_job.rb",
|
30
|
+
"resque-throttle.gemspec",
|
31
|
+
"test/resque/resque_test.rb",
|
32
|
+
"test/resque/throttled_job_test.rb",
|
33
|
+
"test/test_helper.rb"
|
34
|
+
]
|
35
|
+
s.homepage = %q{http://github.com/zendesk/resque-throttle}
|
36
|
+
s.rdoc_options = ["--charset=UTF-8"]
|
37
|
+
s.require_paths = ["lib"]
|
38
|
+
s.rubygems_version = %q{1.3.5}
|
39
|
+
s.summary = %q{resque-throttle is an extension to the resque queue system that restricts the frequency in which certain jobs are run.}
|
40
|
+
s.test_files = [
|
41
|
+
"test/resque/resque_test.rb",
|
42
|
+
"test/resque/throttled_job_test.rb",
|
43
|
+
"test/test_helper.rb"
|
44
|
+
]
|
45
|
+
|
46
|
+
if s.respond_to? :specification_version then
|
47
|
+
current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
|
48
|
+
s.specification_version = 3
|
49
|
+
|
50
|
+
if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
|
51
|
+
s.add_runtime_dependency(%q<resque>, [">= 1.4.0"])
|
52
|
+
s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
|
53
|
+
s.add_development_dependency(%q<mocha>, [">= 0.9.8"])
|
54
|
+
else
|
55
|
+
s.add_dependency(%q<resque>, [">= 1.4.0"])
|
56
|
+
s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
|
57
|
+
s.add_dependency(%q<mocha>, [">= 0.9.8"])
|
58
|
+
end
|
59
|
+
else
|
60
|
+
s.add_dependency(%q<resque>, [">= 1.4.0"])
|
61
|
+
s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
|
62
|
+
s.add_dependency(%q<mocha>, [">= 0.9.8"])
|
63
|
+
end
|
64
|
+
end
|
65
|
+
|
@@ -0,0 +1,28 @@
|
|
1
|
+
require 'test_helper.rb'
|
2
|
+
|
3
|
+
class ResqueTest < Test::Unit::TestCase
|
4
|
+
|
5
|
+
context "Resque" do
|
6
|
+
setup do
|
7
|
+
Resque.redis.flush_all
|
8
|
+
assert_nil Resque.redis.get(OneHourThrottledJob.key)
|
9
|
+
@bogus_args = [1, 2]
|
10
|
+
end
|
11
|
+
|
12
|
+
context "#enqueue" do
|
13
|
+
should "add a throttled job key to the set with the proper TTL (Expire)" do
|
14
|
+
Resque.expects(:enqueue_without_throttle).returns(true)
|
15
|
+
assert Resque.enqueue(OneHourThrottledJob, @bogus_args)
|
16
|
+
assert Resque.redis.get(OneHourThrottledJob.key)
|
17
|
+
assert_equal 3600, Resque.redis.ttl(OneHourThrottledJob.key)
|
18
|
+
end
|
19
|
+
|
20
|
+
context "job has not reached throttle limit" do
|
21
|
+
should "not add another job to the queue and raise a throttled exception" do
|
22
|
+
Resque.expects(:enqueue_without_throttle).once
|
23
|
+
assert_raises(Resque::ThrottledError) { 2.times { Resque.enqueue(OneHourThrottledJob, @bogus_args) } }
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
27
|
+
end
|
28
|
+
end
|
@@ -0,0 +1,40 @@
|
|
1
|
+
require 'test_helper.rb'
|
2
|
+
|
3
|
+
class ThrottledJobTest < Test::Unit::TestCase
|
4
|
+
|
5
|
+
context "Resque::ThrottledJob" do
|
6
|
+
should "instantiate a new Resque::ThrottledJob" do
|
7
|
+
assert Resque::ThrottledJob.new(:queue_name, OneHourThrottledJob)
|
8
|
+
end
|
9
|
+
|
10
|
+
context "#throttle" do
|
11
|
+
should "return the number of seconds in which to throttle these jobs" do
|
12
|
+
assert_equal 3600, OneHourThrottledJob.throttle
|
13
|
+
end
|
14
|
+
|
15
|
+
should "default to 30 minutes (1800 seconds) if not provided" do
|
16
|
+
assert_equal 1800, DefaultThrottledJob.throttle
|
17
|
+
end
|
18
|
+
end
|
19
|
+
|
20
|
+
context "#identifier" do
|
21
|
+
should "return an additional key identifier used in storing the key in the redis SET" do
|
22
|
+
assert_equal "my_identifier", IdetifierThrottledJob.identifier
|
23
|
+
end
|
24
|
+
|
25
|
+
should "return nil if not defined" do
|
26
|
+
assert_nil DefaultThrottledJob.identifier
|
27
|
+
end
|
28
|
+
end
|
29
|
+
|
30
|
+
context "#key" do
|
31
|
+
should "consist of the class name and the identifier" do
|
32
|
+
assert_equal "IdetifierThrottledJob:my_identifier", IdetifierThrottledJob.key
|
33
|
+
end
|
34
|
+
|
35
|
+
should "consist of just the class name if the identifier is not provided" do
|
36
|
+
assert_equal "DefaultThrottledJob", DefaultThrottledJob.key
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
40
|
+
end
|
data/test/test_helper.rb
ADDED
@@ -0,0 +1,43 @@
|
|
1
|
+
require 'rubygems'
|
2
|
+
require 'test/unit'
|
3
|
+
require 'shoulda'
|
4
|
+
require 'mocha'
|
5
|
+
|
6
|
+
$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
|
7
|
+
$LOAD_PATH.unshift(File.dirname(__FILE__))
|
8
|
+
require 'resque/resque'
|
9
|
+
require 'resque/throttle'
|
10
|
+
require 'resque/throttled_job'
|
11
|
+
|
12
|
+
class Test::Unit::TestCase
|
13
|
+
end
|
14
|
+
|
15
|
+
#fixture classes
|
16
|
+
class DefaultThrottledJob < Resque::ThrottledJob
|
17
|
+
@queue = :some_queue
|
18
|
+
|
19
|
+
def self.perform(some_id, some_other_thing)
|
20
|
+
end
|
21
|
+
end
|
22
|
+
|
23
|
+
class OneHourThrottledJob < Resque::ThrottledJob
|
24
|
+
@queue = :some_queue
|
25
|
+
|
26
|
+
def self.throttle
|
27
|
+
3600
|
28
|
+
end
|
29
|
+
|
30
|
+
def self.perform(some_id, some_other_thing)
|
31
|
+
end
|
32
|
+
end
|
33
|
+
|
34
|
+
class IdetifierThrottledJob < Resque::ThrottledJob
|
35
|
+
@queue = :some_queue
|
36
|
+
|
37
|
+
def self.identifier
|
38
|
+
"my_identifier"
|
39
|
+
end
|
40
|
+
|
41
|
+
def self.perform(some_id, some_other_thing)
|
42
|
+
end
|
43
|
+
end
|
metadata
ADDED
@@ -0,0 +1,100 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: resque-throttle
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- scotttam
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
|
12
|
+
date: 2010-02-17 00:00:00 -08:00
|
13
|
+
default_executable:
|
14
|
+
dependencies:
|
15
|
+
- !ruby/object:Gem::Dependency
|
16
|
+
name: resque
|
17
|
+
type: :runtime
|
18
|
+
version_requirement:
|
19
|
+
version_requirements: !ruby/object:Gem::Requirement
|
20
|
+
requirements:
|
21
|
+
- - ">="
|
22
|
+
- !ruby/object:Gem::Version
|
23
|
+
version: 1.4.0
|
24
|
+
version:
|
25
|
+
- !ruby/object:Gem::Dependency
|
26
|
+
name: thoughtbot-shoulda
|
27
|
+
type: :development
|
28
|
+
version_requirement:
|
29
|
+
version_requirements: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: "0"
|
34
|
+
version:
|
35
|
+
- !ruby/object:Gem::Dependency
|
36
|
+
name: mocha
|
37
|
+
type: :development
|
38
|
+
version_requirement:
|
39
|
+
version_requirements: !ruby/object:Gem::Requirement
|
40
|
+
requirements:
|
41
|
+
- - ">="
|
42
|
+
- !ruby/object:Gem::Version
|
43
|
+
version: 0.9.8
|
44
|
+
version:
|
45
|
+
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.
|
46
|
+
email: scott@zendesk.com
|
47
|
+
executables: []
|
48
|
+
|
49
|
+
extensions: []
|
50
|
+
|
51
|
+
extra_rdoc_files:
|
52
|
+
- LICENSE
|
53
|
+
- README.rdoc
|
54
|
+
files:
|
55
|
+
- .document
|
56
|
+
- .gitignore
|
57
|
+
- LICENSE
|
58
|
+
- README.rdoc
|
59
|
+
- Rakefile
|
60
|
+
- VERSION
|
61
|
+
- lib/init.rb
|
62
|
+
- lib/resque/resque.rb
|
63
|
+
- lib/resque/throttle.rb
|
64
|
+
- lib/resque/throttled_job.rb
|
65
|
+
- resque-throttle.gemspec
|
66
|
+
- test/resque/resque_test.rb
|
67
|
+
- test/resque/throttled_job_test.rb
|
68
|
+
- test/test_helper.rb
|
69
|
+
has_rdoc: true
|
70
|
+
homepage: http://github.com/zendesk/resque-throttle
|
71
|
+
licenses: []
|
72
|
+
|
73
|
+
post_install_message:
|
74
|
+
rdoc_options:
|
75
|
+
- --charset=UTF-8
|
76
|
+
require_paths:
|
77
|
+
- lib
|
78
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: "0"
|
83
|
+
version:
|
84
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
85
|
+
requirements:
|
86
|
+
- - ">="
|
87
|
+
- !ruby/object:Gem::Version
|
88
|
+
version: "0"
|
89
|
+
version:
|
90
|
+
requirements: []
|
91
|
+
|
92
|
+
rubyforge_project:
|
93
|
+
rubygems_version: 1.3.5
|
94
|
+
signing_key:
|
95
|
+
specification_version: 3
|
96
|
+
summary: resque-throttle is an extension to the resque queue system that restricts the frequency in which certain jobs are run.
|
97
|
+
test_files:
|
98
|
+
- test/resque/resque_test.rb
|
99
|
+
- test/resque/throttled_job_test.rb
|
100
|
+
- test/test_helper.rb
|