resque-throttle 0.2.18 → 0.2.19

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

@@ -10,7 +10,7 @@ begin
     gem.email = "tamosunas@gmail.com"
     gem.homepage = "http://github.com/scotttam/resque-throttle"
     gem.authors = ["Scott J. Tamosunas"]
-    gem.add_dependency "scotttam-resque", ">=0.0.5"
+    gem.add_dependency "resque", ">=1.6.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

data/VERSION

@@ -1 +1 @@
-0.2.18
+0.2.19

data/resque-throttle.gemspec

@@ -5,22 +5,22 @@
 
 Gem::Specification.new do |s|
   s.name = %q{resque-throttle}
-  s.version = "0.2.18"
+  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-08}
+  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.rdoc"
+     "README.markdown"
   ]
   s.files = [
     ".document",
      ".gitignore",
      "LICENSE",
-     "README.rdoc",
+     "README.markdown",
      "Rakefile",
      "VERSION",
      "lib/resque-throttle.rb",
@@ -48,16 +48,16 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<scotttam-resque>, [">= 0.0.5"])
+      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<scotttam-resque>, [">= 0.0.5"])
+      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<scotttam-resque>, [">= 0.0.5"])
+    s.add_dependency(%q<resque>, [">= 1.6.0"])
     s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
     s.add_dependency(%q<mocha>, [">= 0.9.8"])
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: resque-throttle
 version: !ruby/object:Gem::Version 
-  version: 0.2.18
+  version: 0.2.19
 platform: ruby
 authors: 
 - Scott J. Tamosunas
@@ -9,18 +9,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-08 00:00:00 -08:00
+date: 2010-03-10 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: scotttam-resque
+  name: resque
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.0.5
+        version: 1.6.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: thoughtbot-shoulda
@@ -50,12 +50,12 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.markdown
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION
 - lib/resque-throttle.rb

data/README.rdoc

@@ -1,17 +0,0 @@
-= 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.