delayed_job_recurring 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a415c64ebb7f90d1e582264d12150ea51ca9035e
+  data.tar.gz: 018743cb2951f1b615796103e7a16b66de915ca5
+SHA512:
+  metadata.gz: 3a741233a41bdd26c970abf7e1eb9fc96b8dee93f0990d0925fa6d67ad918bc1537fc52219869156b5aaccec96203b6c7cdeceb3bc0db7ec4817760e0cc56a6a
+  data.tar.gz: d5ebc8c0ae9e1d2fc6b0503d432ee72b72e41273e1c268c9343cb7ca9a1122a88370dbba65fe9ede822831a013d649817bde53a1a575a681b35ee8ccc159c084

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Amitree
+
+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.md

@@ -0,0 +1,49 @@
+# delayed\_job\_recurring
+
+Extends delayed\_job to support recurring jobs.
+
+## Usage
+
+In your Gemfile:
+
+```ruby
+gem 'delayed_job_recurring'
+```
+
+Then define a task class:
+
+```ruby
+class MyTask
+  include Delayed::RecurringJob
+  run_every 1.day
+  run_at DateTime.parse('2014-03-08 11:00:00 PST')
+  timezone 'US/Pacific'
+  def perform
+    # Do some work here!
+  end
+end
+```
+
+And schedule it. In a rails app, you might put this in an initializer:
+
+```ruby
+MyTask.schedule # run every day at 11am Pacific time (accounting for daylight savings)
+```
+
+## Advanced usage
+
+### Passing options to schedule
+
+```ruby
+MyTask.schedule(run_at: DateTime.parse('2014-03-08 11:00:00 PST'))
+```
+
+### Running at multiples times each day
+
+```ruby
+MyTask.schedule(run_every: 1.day, run_at: [DateTime.parse('2014-03-08 11:00:00 PST'), DateTime.parse('2014-03-08 18:00:00 PST')]
+```
+
+## Thanks!
+
+Many thanks to @ginjo and @kares for their work!  This code was derived from https://gist.github.com/ginjo/3688965.

data/lib/delayed/recurring_job.rb

@@ -0,0 +1,172 @@
+#
+# Delayed::RecurringJob
+#
+# Inspired by https://gist.github.com/ginjo/3688965
+#
+module Delayed
+  module RecurringJob
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.class_eval do
+        @@logger = Delayed::Worker.logger
+        cattr_reader :logger
+      end
+    end
+
+    def failure
+      schedule!
+    end
+
+    def success
+      schedule!
+    end
+
+    # Schedule this "repeating" job
+    def schedule! options = {}
+      @schedule_options = options.reverse_merge(@schedule_options || {}).reverse_merge(
+        run_at: self.class.run_at,
+        timezone: self.class.timezone,
+        run_interval: serialize_duration(self.class.run_every)
+      )
+
+      enqueue_opts = { priority: 0, run_at: next_run_time }
+
+      if Gem.loaded_specs['delayed_job'].version.to_s.first.to_i < 3
+        Delayed::Job.enqueue self, enqueue_opts[:priority], enqueue_opts[:run_at]
+      else
+        Delayed::Job.enqueue self, enqueue_opts
+      end
+    end
+
+    def next_run_time
+      times = @schedule_options[:run_at]
+      times = [times] unless times.is_a? Array
+      times = times.map{|time| time.in_time_zone @schedule_options[:timezone]} if @schedule_options[:timezone]
+
+      interval = deserialize_duration(@schedule_options[:run_interval])
+
+      until next_time = next_future_time(times)
+        times.map!{ |time| time + interval }
+      end
+
+      # Update @schedule_options to avoid growing number of calculations each time
+      @schedule_options[:run_at] = times
+
+      next_time
+    end
+
+  private
+    # We don't want the run_interval to be serialized as a number of seconds.
+    # 1.day is not the same as 86400 (not all days are 86400 seconds long!)
+    def serialize_duration(duration)
+      case duration
+      when ActiveSupport::Duration
+        {value: duration.value, parts: duration.parts}
+      else
+        duration
+      end
+    end
+
+    def deserialize_duration(serialized)
+      case serialized
+      when Hash
+        ActiveSupport::Duration.new(serialized[:value], serialized[:parts])
+      else
+        serialized
+      end
+    end
+
+    def next_future_time(times)
+      times.select{|time| time > Time.now}.min
+    end
+
+    module ClassMethods
+      def run_at(time = nil)
+        if time.nil?
+          @run_at || run_every.from_now
+        else
+          @run_at = time
+        end
+      end
+
+      def run_every(interval = nil)
+        if interval.nil?
+          @run_interval || 1.hour
+        else
+          @run_interval = interval
+        end
+      end
+
+      def timezone(zone = nil)
+        if zone.nil?
+          @tz
+        else
+          @tz = zone
+        end
+      end
+
+      # Show all jobs for this schedule
+      def jobs
+        ::Delayed::Job.where("(handler LIKE ?) OR (handler LIKE ?)", "--- !ruby/object:#{name} %", "--- !ruby/object:#{name}\n%")
+      end
+
+      # Remove all jobs for this schedule (Stop the schedule)
+      def unschedule
+        jobs.each{|j| j.destroy}
+      end
+
+      # Main interface to start this schedule (adds it to the jobs table).
+      # Pass in a time to run the first job (nil runs the first job at run_interval from now).
+      def schedule(options = {})
+        schedule!(options) if Delayed::Worker.delay_jobs && !scheduled?
+      end
+
+      def schedule!(options = {})
+        new.schedule!(options)
+      end
+
+      def scheduled?
+        jobs.count > 0
+      end
+
+    end # ClassMethods
+  end # RecurringJob
+
+  module Task
+    # Creates a new class wrapper around a block of code to be scheduled.
+    def self.new(name, options, &block)
+      task_class = Class.new
+      task_class.class_eval do
+        include Delayed::RecurringJob
+
+        def display_name
+          self.class.name
+        end
+
+        def perform
+          block.call
+        end
+      end
+
+      Object.const_set(name, task_class) if name
+      task_class.schedule(options)
+      return task_class
+    end
+
+    # Schedule a block of code on-the-fly.
+    # This is a friendly wrapper for using Task.new without an explicit constant assignment.
+    # Delayed::Task.schedule('MyNewTask', run_every: 10.minutes, run_at: 1.minute.from_now){do_some_stuff_here}
+    # or
+    # Delayed::Task.schedule(run_every: 10.minutes, run_at: 1.minute.from_now){do_some_stuff_here}
+    def self.schedule(name_or_options={}, options={}, &block)
+      case name_or_options
+      when Hash
+        name, options = nil, name_or_options
+      else
+        name = name_or_options
+      end
+
+      self.new name, options, &block
+    end
+  end  # Task
+end # Delayed

data/lib/delayed_job_recurring.rb

@@ -0,0 +1,3 @@
+require 'delayed_job'
+require 'delayed_job_active_record'
+require 'delayed/recurring_job'

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: delayed_job_recurring
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Tony Novak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: delayed_job
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: delayed_job_active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Extends delayed_job to support recurring jobs, including timezone support
+email: engineering@amitree.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/delayed/recurring_job.rb
+- lib/delayed_job_recurring.rb
+homepage: https://github.com/amitree/delayed_job_recurring
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Recurring jobs for delayed_job
+test_files: []