simple_scheduler 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a609cbea37bbbcfc43aa830039a3b89ab2467bf9
-  data.tar.gz: a4bafa4c6c324a4dd75e0b5b4cb49076a4313d40
+  metadata.gz: ff28ce865f99e1cb0a04b2f8d1ece60998e1a096
+  data.tar.gz: 1416ef9bbb7296fb2db35030f5cd2811c5667303
 SHA512:
-  metadata.gz: a5eb15d2033392fb29a3305bd81485fe940a673f55583e0aaaa0c5bf0f029c52570c80c399ca05ffc5f94d9820144f62f8fa245fd02a76ae4087846f66a7802f
-  data.tar.gz: 8a5807630dc3881df1810a299540f67226c81a6973556972f7944b50c906b9b42790168c0593ce3bb385214db414d8ee41664a8559ca486985531dfea50f7dc4
+  metadata.gz: 385b890ba17e8acdcaac2560fa34a67aee4341a38f91ed30b92bc26ad6c54c9b9a492740bbbb32447196236b168beae4ed1b8a2c07a10b80b17e8809988ce684
+  data.tar.gz: 9ab1dff5976d4272bb7097cde27fa105fa1dbd792a1f06843955965c48ee3e1e56c3fa2b83930a3ed86272189d8add425096adfb09dc02b3ccd2114ace1b1daf

data/README.md

@@ -12,6 +12,17 @@ gives you the ability to **schedule tasks at any interval** without adding
 a clock process. Heroku Scheduler only allows you to schedule tasks every 10 minutes,
 every hour, or every day.
 
+## Production Ready?
+
+**Yes.** We are using Simple Scheduler in production for scheduling hourly,
+nightly, and weekly tasks in [Simple In/Out](https://www.simpleinout.com).
+
+### Why did we need to create yet another job scheduler?
+
+Every option we evaluated seems to have the same flaw: **If your server is down, your job won't run.**
+
+[Check out our intro blog post to learn more](http://www.simplymadeapps.com/blog/2017/01/simple-scheduler-schedule-recurring-tasks-to-run-at-any-interval/).
+
 ## Requirements
 
 You must be using:
@@ -43,9 +54,9 @@ $ bundle
 Create the file `config/simple_scheduler.yml` in your Rails project:
 
 ```yml
-# Global configuration options and their defaults. These can also be set on each task.
+# Global configuration options. These can also be set on each task.
 queue_ahead: 360 # Number of minutes to queue jobs into the future
-tz: nil # The application time zone will be used by default
+tz: "America/Chicago" # The application time zone will be used by default if not set
 
 # Runs once every 2 minutes
 simple_task:
@@ -60,7 +71,7 @@ overnight_task:
   at: "4:00"
   expires_after: "23.hours"
 
-# Runs once every hour at the half hour
+# Runs once every half hour, starting on the 30 min mark
 half_hour_task:
   class: "HalfHourTask"
   every: "30.minutes"
@@ -71,7 +82,7 @@ weekly_task:
   class: "WeeklyJob"
   every: "1.week"
   at: "Sat 0:00"
-  tz: "America/Chicago"
+  tz: "America/New_York"
 ```
 
 ### Set up Heroku Scheduler
@@ -208,78 +219,6 @@ If you're using a custom configuration file:
 rake simple_scheduler:reset["config/simple_scheduler.staging.yml"]
 ```
 
-## How It Works
-
-The Heroku Scheduler must be set up to run `rake simple_scheduler` every 10 minutes.
-The rake task will load the configuration file each time and ensure that each task has
-jobs scheduled for the future. This is done by checking the `Sidekiq::ScheduledSet`.
-
-A minimum of two jobs is always added to the scheduled set. By default all
-jobs for the next six hours are queued in advance. This ensures that there is
-always one job in the queue that can be used to determine the next run time,
-even if one of the two was executed during the 10 minute scheduler wait time.
-
-### Server Downtime Example
-
-If you're using a gem like [clockwork](https://github.com/Rykian/clockwork),
-there is no way for the clock process to know that the task was never run.
-If your task is scheduled for `12:00:00`, your clock process could possibly
-be restarted at `11:59:59` and your dyno might not be available until `12:00:20`.
-
-Simple Scheduler would have already enqueued the task hours before the task should actually
-run, so you still have to worry about the worker dyno restarting, but when the worker
-dyno becomes available, the enqueued task will be there and will be executed immediately.
-
-### Daily Digest Email Example
-
-Here's an example of a daily digest email that needs to go out at 8:00 AM for
-users in their local time zone. We need to run this every 15 minutes to handle
-all time zone offsets.
-
-config/simple_scheduler.yml:
-
-```yml
-# Runs every hour starting at the top of the hour + every 15 minutes
-daily_digest_task:
-  class: "DailyDigestEmailJob"
-  every: "15.minutes"
-  at: "*:00"
-  expires_after: "23.hours"
-```
-
-app/jobs/daily_digest_email_job.rb:
-
-```ruby
-class DailyDigestEmailJob < ApplicationJob
-  queue_as :default
-
-  # Called by Simple Scheduler and is given the scheduled time so decisions can be made
-  # based on when the job was scheduled to be run rather than when it was actually run.
-  # @param scheduled_time [Integer] The epoch time for when the job was scheduled to be run
-  def perform(scheduled_time)
-    # Don't do this! This will be way too slow!
-    User.find_each do |user|
-      if user.digest_time == Time.at(scheduled_time)
-        DigestMailer.daily(user).deliver_later
-      end
-    end
-  end
-end
-```
-
-app/models/user.rb:
-
-```ruby
-class User < ApplicationRecord
-  # Returns the time the user's daily digest should be
-  # delivered today based on the user's time zone.
-  # @return [Time]
-  def digest_time
-    "8:00 AM".in_time_zone(self.time_zone)
-  end
-end
-```
-
 ## Contributing
 
 1. Fork it

data/lib/simple_scheduler/at.rb

@@ -22,9 +22,9 @@ module SimpleScheduler
     #   "[Sun|Mon|Tue|Wed|Thu|Fri|Sat] 00:00"
     # @param at [String] The formatted string for a task's run time
     # @param time_zone [ActiveSupport::TimeZone] The time zone to parse the at time in
-    def initialize(at, time_zone = Time.zone)
+    def initialize(at, time_zone = nil)
       @at = at
-      @time_zone = time_zone
+      @time_zone = time_zone || Time.zone
       super(parsed_time.year, parsed_time.month, parsed_time.day,
             parsed_time.hour, parsed_time.min, parsed_time.sec, parsed_time.utc_offset)
     end

data/lib/simple_scheduler/version.rb

@@ -1,3 +1,3 @@
 module SimpleScheduler
-  VERSION = "0.2.4".freeze
+  VERSION = "0.2.5".freeze
 end

metadata

@@ -1,139 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: simple_scheduler
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Brian Pattison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-27 00:00:00.000000000 Z
+date: 2017-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '4.2'
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4.2'
 - !ruby/object:Gem::Dependency
   name: appraisal
   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: codeclimate-test-reporter
   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: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: rspec-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: rubocop
   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: simplecov
   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: simplecov-rcov
   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'
 description: |2
@@ -146,17 +146,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
-- README.md
-- Rakefile
-- lib/simple_scheduler.rb
 - lib/simple_scheduler/at.rb
 - lib/simple_scheduler/future_job.rb
 - lib/simple_scheduler/railtie.rb
 - lib/simple_scheduler/scheduler_job.rb
 - lib/simple_scheduler/task.rb
 - lib/simple_scheduler/version.rb
+- lib/simple_scheduler.rb
 - lib/tasks/simple_scheduler_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
 homepage: https://github.com/simplymadeapps/simple_scheduler
 licenses:
 - MIT
@@ -167,17 +167,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: An enhancement for Heroku Scheduler + Sidekiq for scheduling jobs at specific