resque-throttle 0.1.0 → 0.2.0

data/.gitignore

@@ -19,3 +19,4 @@ rdoc
 pkg
 
 ## PROJECT::SPECIFIC
+.idea

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/resque/resque.rb

@@ -18,14 +18,14 @@ module Resque
   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
+    return false if !throttle_job?(klass) || klass.disabled
+    return true if key_found?(klass)
+    redis.set(klass.key, true, klass.can_run_every)
+    return false
+  end
+
+  def key_found?(klass)
+     redis.get(klass.key)
   end
 
   def throttle_job?(klass)

data/lib/resque/throttled_job.rb

@@ -1,16 +1,32 @@
 module Resque
+  class SettingNotFound < RuntimeError; end
+
   class ThrottledJob < Job
-    
-    def self.identifier
-      nil
+
+    THROTTLE_DEFAULTS = {
+        :can_run_every => 1800,
+        :enqueued      => 'Your job has been submitted. You will receive an email with a download link shortly.',
+        :throttled     => 'Frequency has been exceeded. Job not submitted. Try again a little later.',
+        :latest        => 'Download the most recent result',
+        :disabled      => false,
+        :identifier    => nil
+    }
+
+    def self.settings
+      @settings ||= THROTTLE_DEFAULTS.dup
     end
-    
-    def self.throttle
-      1800
+
+    def self.throttle(args = {})
+      settings.merge!(args)
     end
-    
+
     def self.key
       [self.to_s, identifier].compact.join(":")
     end
+
+    def self.method_missing(method, *args)
+      raise SettingNotFound("Could not find the #{method} setting") if !settings.key?(method)
+      settings[method]
+    end
   end
 end

data/resque-throttle.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{resque-throttle}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   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.date = %q{2010-02-18}
   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 = [

data/test/resque/resque_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper.rb'
+require '../test_helper.rb'
 
 class ResqueTest < Test::Unit::TestCase
 
@@ -23,6 +23,11 @@ class ResqueTest < Test::Unit::TestCase
           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
     end
   end
 end

data/test/resque/throttled_job_test.rb

@@ -1,37 +1,79 @@
-require 'test_helper.rb'
+require '../test_helper.rb'
 
 class ThrottledJobTest < Test::Unit::TestCase
- 
-  context "Resque::ThrottledJob" do 
+
+  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
+
+    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", IdetifierThrottledJob.identifier
+        end
+
+        should "return nil if not defined" do
+          assert_nil DefaultThrottledJob.identifier
+        end
+      end
+
+      context "#enqueued" do
+        should "have a default message if not overrriden" do
+          assert_equal "Your job has been submitted. You will receive an email with a download link shortly.", DefaultThrottledJob.enqueued
+        end
+
+        should "be able to be overriden" do
+          assert_equal "Yada Yada", OneHourThrottledJob.enqueued
+        end
       end
-      
-      should "return nil if not defined" do
-        assert_nil DefaultThrottledJob.identifier
+
+      context "#throttled" do
+        should "have a default message if not overrriden" do
+          assert_equal "Frequency has been exceeded. Job not submitted. Try again a little later.", DefaultThrottledJob.throttled
+        end
+
+        should "be able to be overriden" do
+          assert_equal "Yada Yada", OneHourThrottledJob.throttled
+        end
+      end
+
+      context "#latest" do
+        should "have a default message if not overrriden" do
+          assert_equal "Download the most recent result", DefaultThrottledJob.latest
+        end
+
+        should "be able to be overriden" do
+          assert_equal "Yada Yada", OneHourThrottledJob.latest
+        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 the class name and the identifier" do
-         assert_equal "IdetifierThrottledJob:my_identifier", IdetifierThrottledJob.key
+        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

data/test/test_helper.rb

@@ -23,10 +23,12 @@ end
 class OneHourThrottledJob < Resque::ThrottledJob
   @queue = :some_queue
 
-  def self.throttle
-    3600
-  end
-  
+  throttle :can_run_every => 3600,
+           :enqueued => "Yada Yada",
+           :throttled => "Yada Yada",
+           :latest => "Yada Yada"
+
+
   def self.perform(some_id, some_other_thing)
   end
 end
@@ -34,10 +36,17 @@ end
 class IdetifierThrottledJob < Resque::ThrottledJob
   @queue = :some_queue
 
-  def self.identifier
-    "my_identifier"
+  throttle :identifier => "my_identifier" 
+
+  def self.perform(some_id, some_other_thing)
   end
-  
+end
+
+class DisabledThrottledJob < Resque::ThrottledJob
+  @queue = :some_queue
+
+  throttle :disabled => true
+
   def self.perform(some_id, some_other_thing)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: resque-throttle
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - scotttam
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-17 00:00:00 -08:00
+date: 2010-02-18 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency