resque-timeframe 0.1.0 → 0.2.0

data/CHANGELOG

@@ -1,3 +1,8 @@
+## 0.2.0 (2010-08-12)
+
++ Job Delay if it out of timeframe.
++ Imroved timeframe function
+
 ## 0.1.0 (2010-08-11)
 
 * First release.

data/README.markdown

@@ -50,15 +50,41 @@ or like this
 
     @queue = :timeframed_queue
 
-    def self.perform(args)
-    end
+    def self.perform(args); end
+  end
+
+  class ArchiveJob < Resque::Plugins::TimeframedJob
+    timeframe week - [:saturday, :sunday] => 0..9
+
+    @queue = :timeframed_queue
+
+    def self.perform(args); end
+  end
+
+
+All timeframed jobs would be delayed in 60 seconds if job out of timeframe. Delay could be configured of set to false. If delay set to false all jobs would be removed from queue.
+
+  class Job < Resque::Plugins::TimeframedJob
+    timeframe :recurrent => 900 # in seconds
+
+    @queue = :timeframed_queue
+    def self.perform(args); end
+  end
+
+or
+
+  class HaveAChanceJob < Resque::Plugins::TimeframedJob
+    timeframe :recurrent => false
+
+    @queue = :timeframed_queue
+    def self.perform(args); end
   end
 
 
 
 Copyright
 ---------
-Copyright (c) 2010 Dmitry Larkin (at [Railsware][3])
+Copyright (c) 2010 Dmitry Larkin (at [Railsware][3] for [Ratepoint][4])
 
 
 
@@ -66,3 +92,5 @@ Copyright (c) 2010 Dmitry Larkin (at [Railsware][3])
 [1]: http://help.github.com/forking/
 [2]: http://github.com/dml/resque-timeframe/issues
 [3]: http://railsware.com
+[4]: http://ratepoint.com
+[5]: http://github.com/bvandenbos/resque-scheduler

data/lib/resque-timeframe/timeframe.rb

@@ -11,11 +11,22 @@ module Resque
       end
 
       def settings
-        @options ||= WEEK.inject({:default => true}) {|c,v| c.merge({v => true})}
+        @options ||= WEEK.inject({:default => true, :recurrent => 60}) {|c,v| c.merge({v => true})}
       end
 
-      def timeframe(options={})
-        settings.merge!(options)
+      def timeframe(options = {})
+        options.map do |param,value|
+          case param
+            when Array
+              param.map {|k| timeframe({k => value}) }
+            when String
+              timeframe({param.to_sym => value})
+            when Symbol
+              settings.merge!({param => value})
+            else
+              # 
+          end
+        end
       end
 
       def allowed_at?(weekday)
@@ -52,7 +63,11 @@ module Resque
       end
 
       def before_perform_timeframe(*args)
-        raise Resque::Job::DontPerform unless allowed_at?(week[Time.new.wday])
+        unless allowed_at?(week[Time.new.wday])
+          Resque.enqueue_in(settings[:recurrent], self, *args) if settings[:recurrent]
+
+          raise Resque::Job::DontPerform
+        end
       end
 
     end

data/lib/resque-timeframe/version.rb

@@ -1,7 +1,7 @@
 module ResqueTimeframe
   module VERSION
     MAJOR = 0
-    MINOR = 1
+    MINOR = 2
     TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')

data/lib/resque-timeframe.rb

@@ -1,2 +1,3 @@
 require 'resque'
+require 'resque_scheduler'
 require 'resque-timeframe/timeframe'

data/spec/resque-timeframe/timeframed_job_spec.rb

@@ -2,6 +2,10 @@ require File.join(File.dirname(__FILE__) + '/../spec_helper')
 
 describe Resque::Plugins::Timeframe do
 
+  before(:all) do
+    @monday = Time.mktime(2010, 8, 9, 00, 00, 00)
+  end
+
   context "Convention" do
     it "should follow the convention" do
       lambda {
@@ -30,6 +34,88 @@ describe Resque::Plugins::Timeframe do
     end
   end
 
+  context "Timeframe" do
+    before(:all) do
+      @klass = Class.new
+      @klass.extend Resque::Plugins::Timeframe
+    end
+
+    it "should have defined weeks" do
+      @klass.week.should be_kind_of(Array)
+    end
+
+    it "should have defined settings" do
+      @klass.settings.should be_kind_of(Hash)
+    end
+
+    it "should default true for a weeks days" do
+      @klass.week.each do |dayoweek|
+        @klass.settings[dayoweek].should be_true
+      end
+    end
+
+    context "defining a day timeframe" do
+      before(:each) do
+        @day_of_week = :monday
+        @period = 2..11
+        @klass.timeframe @day_of_week => @period
+      end
+
+      it "should set one day settings" do
+        @klass.settings[@day_of_week].should == @period
+      end
+
+      it "should not affect other day settings" do
+        (@klass.week - [:monday]).each do |dayoweek|
+          @klass.settings[dayoweek].should be_true
+        end
+      end
+    end
+
+    context "defining few days timeframes" do
+      before(:each) do
+        @days_of_week = [:monday, :wednesday, :friday]
+        @period = 7..19
+        @klass.timeframe @days_of_week => @period
+      end
+
+      it "should set one day settings" do
+        @days_of_week.each do |dayoweek|
+          @klass.settings[dayoweek].should == @period
+        end
+      end
+
+      it "should not affect other day settings" do
+        (@klass.week - @days_of_week).each do |dayoweek|
+          @klass.settings[dayoweek].should be_true
+        end
+      end
+    end
+
+    context "defining few days timeframes" do
+      before(:each) do
+        @days_of_week1 = [:monday, :wednesday]
+        @day_of_week2 = :friday
+        @period1 = 7..19
+        @period2 = 3..16
+        @klass.timeframe @days_of_week1 => @period1, @day_of_week2 => @period2
+      end
+
+      it "should set one day settings" do
+        @days_of_week1.each do |dayoweek|
+          @klass.settings[dayoweek].should == @period1
+        end
+        @klass.settings[@day_of_week2].should == @period2
+      end
+
+      it "should not affect other day settings" do
+        (@klass.week - @days_of_week1 - [@day_of_week2]).each do |dayoweek|
+          @klass.settings[dayoweek].should be_true
+        end
+      end
+    end
+  end
+
   context "Settings" do
     it "should allowed by default" do
       AllowedByDefaultTimeframeJob.allowed_at?(:monday).should be_true
@@ -40,13 +126,13 @@ describe Resque::Plugins::Timeframe do
     end
 
     it "should allow a job if exact time range specified" do
-      @time = Time.mktime(2010, 8, 11, 11, 21, 00)
+      @time = @monday + (60*60 * 24 * 4) + (60*60 * 11) + (60 * 21) # 11:21 @ thursday
       Time.stub!(:now).and_return(@time)
       RegularWeekRestrictionJob.allowed_at?(:thursday).should be_true
     end
 
     it "should does not allow a job if exact time range specified but out of current time" do
-      @time = Time.mktime(2010, 8, 11, 12, 33, 00)
+      @time = @monday + (60*60 * 24 * 5) + (60*60 * 12) + (60 * 33) # 12:33 @ friday
       Time.stub!(:now).and_return(@time)
       RegularWeekRestrictionJob.allowed_at?(:friday).should be_false
     end
@@ -57,7 +143,7 @@ describe Resque::Plugins::Timeframe do
 
     before(:each) do
       Resque.redis.flushall
-      @time = Time.mktime(2010, 8, 11, 11, 59, 00)
+      @time = @monday + (60*60 * 24 * 4) + (60*60 * 11) + (60 * 59) # 11:59 @ thursday
       Time.stub!(:now).and_return(@time)
     end
 
@@ -72,6 +158,27 @@ describe Resque::Plugins::Timeframe do
       result = perform_job(RestrictedByDefaultTimeframeJob, 1)
       result.should be_false
     end
+
+    it "should delay job on a minute if job is out of timeframe" do
+      RestrictedByDefaultTimeframeJob.should_not_receive(:perform)
+      Resque.should_receive(:enqueue_in).with(60, RestrictedByDefaultTimeframeJob, 1)
+      result = perform_job(RestrictedByDefaultTimeframeJob, 1)
+      result.should be_false
+    end
+
+    it "should delay job on custom period if job is out of timeframe" do
+      WorkingDaysTimeframeJob.should_not_receive(:perform)
+      Resque.should_receive(:enqueue_in).with(900, WorkingDaysTimeframeJob, 1)
+      result = perform_job(WorkingDaysTimeframeJob, 1)
+      result.should be_false
+    end
+
+    it "should not perform and remove job if :reccurent is false" do
+      JunkTimeframeJob.should_not_receive(:perform)
+      Resque.should_not_receive(:enqueue_in)
+      result = perform_job(JunkTimeframeJob, 1)
+      result.should be_false
+    end
   end
 
 end

data/spec/spec_helper.rb

@@ -65,12 +65,21 @@ class RestrictedByDefaultTimeframeJob < Resque::Plugins::TimeframedJob
 end
 
 class WorkingDaysTimeframeJob < Resque::Plugins::TimeframedJob
+  timeframe :recurrent => 900
   timeframe week - [:saturday, :sunday] => 0..9 # 24 hour format
 
   @queue = :timeframed_queue
   def self.perform(args); end
 end
 
+class JunkTimeframeJob < Resque::Plugins::TimeframedJob
+  timeframe :recurrent => false
+  timeframe week - [:saturday, :sunday] => 0..9
+
+  @queue = :timeframed_queue
+  def self.perform(args); end
+end
+
 class DisabledDayTimeframeJob < Resque::Plugins::TimeframedJob
   timeframe :sunday => true
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: resque-timeframe
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Dmitry Larkin
@@ -26,14 +26,46 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 11
+        hash: 55
         segments: 
         - 1
-        - 7
+        - 8
         - 0
-        version: 1.7.0
+        version: 1.8.0
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: resque-scheduler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 55
+        segments: 
+        - 1
+        - 8
+        - 0
+        version: 1.8.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: resque
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 55
+        segments: 
+        - 1
+        - 8
+        - 0
+        version: 1.8.0
+  type: :runtime
+  version_requirements: *id003
 description: resque-timeframe is an extension to resque queue system that allow the execution at configured time.
 email: dmitry.larkin@gmail.com
 executables: []
@@ -58,7 +90,7 @@ files:
 - LICENSE
 - CHANGELOG
 has_rdoc: true
-homepage: http://www.railsware.com
+homepage: http://github.com/dml/resque-timeframe
 licenses: []
 
 post_install_message: