simple_scheduler 0.3.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a60a51725c69fc147ebb5b90adb50e784fbf4b5
-  data.tar.gz: 8b4db53f04de5e0812fe5f9d6a6e00392d2be9c7
+  metadata.gz: 778a394ce23dfc08f29201e0d0734a5521c42747
+  data.tar.gz: f35fccb6c74a0a5d5e73c39736b09db21bf1f030
 SHA512:
-  metadata.gz: 3027279bb87fbda962ebb7b583f63011fd038c803c4496d9d04097b2ccdd4e6a7dac8a0fbd65c6568bad883026020057794fa4d1b5d43a176eb050361c3e5f12
-  data.tar.gz: 1361d030b08fef5f7d790ded52d90620af9a9d6db9f2d7bab36973e7f701c300665de670fba252a3548ff161cab743c1aa838fd294b95ab0ebc8526396871fd5
+  metadata.gz: 58b59b0e13d746d27ddbf0261972337957bf912f172ff13fbefa5a0d0186da03446212ce9a105182539043fcf49d2786ab8bf0d926527879660fe54c5103bc29
+  data.tar.gz: 77a7202de9dd23ad87e16c850eb93fe4bf090bd6adf1476ea32300971e622b9118df4fc0b30ac3597e1aca8ec8f46ba8166687c2eade8f49de837fa91f698252

data/README.md

@@ -28,11 +28,14 @@ Every option we evaluated seems to have the same flaw: **If your server is down,
 You must be using:
 
 - Rails 4.2+
+- ActiveJob
 - [Sidekiq](http://sidekiq.org)
-- [Heroku Scheduler](https://elements.heroku.com/addons/scheduler)
+- [Heroku Scheduler](https://elements.heroku.com/addons/scheduler)*
 
 Both Active Job and Sidekiq::Worker classes can be queued by the scheduler.
 
+*\* Not actually required, but you're on your own for scheduling the `rake simple_scheduler` task to run every 10 minutes.*
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -54,8 +57,9 @@ $ bundle
 Create the file `config/simple_scheduler.yml` in your Rails project:
 
 ```yml
-# Global configuration options. These can also be set on each task.
+# Global configuration options. The `queue_ahead` and `tz` options can also be set on each task.
 queue_ahead: 360 # Number of minutes to queue jobs into the future
+queue_name: "default" # The Sidekiq queue name used by SimpleScheduler::FutureJob
 tz: "America/Chicago" # The application time zone will be used by default if not set
 
 # Runs once every 2 minutes
@@ -95,10 +99,11 @@ rake simple_scheduler
 
 ![Heroku Scheduler](https://cloud.githubusercontent.com/assets/124570/21104523/6d733d1a-c04c-11e6-89af-590e7d234cdf.gif)
 
-It may be useful to point to a specific configuration file in non-production environments:
+It may be useful to point to a specific configuration file in non-production environments.
+Use a custom configuration file by setting the `SIMPLE_SCHEDULER_CONFIG` environment variable.
 
 ```
-rake simple_scheduler["config/simple_scheduler.staging.yml"]
+SIMPLE_SCHEDULER_CONFIG=config/simple_scheduler.staging.yml
 ```
 
 ### Task Options
@@ -259,9 +264,9 @@ SimpleScheduler.expired_task do |exception|
   ExceptionNotifier.notify_exception(
     exception,
     data: {
-      task:      exception.task.name,
+      task: exception.task.name,
       scheduled: exception.scheduled_time,
-      actual:    exception.run_time
+      actual: exception.run_time
     }
   )
 end
@@ -279,6 +284,7 @@ Reasons you may need to reset the job queue:
 - Deleting a scheduled task
 - Changing the task's run time interval
 - Changing the day of the week the job is run
+- Changing the `queue_name` in the config file
 
 A rake task exists to delete all existing scheduled jobs and queue them back up from scratch:
 
@@ -286,12 +292,6 @@ A rake task exists to delete all existing scheduled jobs and queue them back up
 rake simple_scheduler:reset
 ```
 
-If you're using a custom configuration file:
-
-```
-rake simple_scheduler:reset["config/simple_scheduler.staging.yml"]
-```
-
 ## Contributing
 
 1. Fork it

data/lib/simple_scheduler/scheduler_job.rb

@@ -1,23 +1,27 @@
 module SimpleScheduler
   # Active Job class that queues jobs defined in the config file.
   class SchedulerJob < ActiveJob::Base
-    # Accepts a file path to read the scheduler configuration.
-    # @param config_path [String]
-    def perform(config_path = nil)
-      config_path ||= "config/simple_scheduler.yml"
-      load_config(config_path)
+    def perform
+      load_config
       queue_future_jobs
     end
 
     private
 
+    # Returns the path of the Simple Scheduler configuration file.
+    # @return [String]
+    def config_path
+      ENV["SIMPLE_SCHEDULER_CONFIG"] || "config/simple_scheduler.yml"
+    end
+
     # Load the global scheduler config from the YAML file.
-    # @param config_path [String]
-    def load_config(config_path)
-      @config = YAML.load(ERB.new(File.read(config_path)).result)
+    def load_config
+      @config = YAML.safe_load(ERB.new(File.read(config_path)).result)
       @queue_ahead = @config["queue_ahead"] || Task::DEFAULT_QUEUE_AHEAD_MINUTES
+      @queue_name = @config["queue_name"] || "default"
       @time_zone = @config["tz"] || Time.zone.tzinfo.name
       @config.delete("queue_ahead")
+      @config.delete("queue_name")
       @config.delete("tz")
     end
 
@@ -27,7 +31,8 @@ module SimpleScheduler
         # Schedule the new run times using the future job wrapper.
         new_run_times = task.future_run_times - task.existing_run_times
         new_run_times.each do |time|
-          SimpleScheduler::FutureJob.set(wait_until: time).perform_later(task.params, time.to_i)
+          SimpleScheduler::FutureJob.set(queue: @queue_name, wait_until: time)
+                                    .perform_later(task.params, time.to_i)
         end
       end
     end

data/lib/simple_scheduler/version.rb

@@ -1,3 +1,3 @@
 module SimpleScheduler
-  VERSION = "0.3.4".freeze
+  VERSION = "1.0.0".freeze
 end

data/lib/tasks/simple_scheduler_tasks.rake

@@ -1,12 +1,12 @@
 desc "Queue future jobs defined using Simple Scheduler"
-task :simple_scheduler, [:config_path] => [:environment] do |_, args|
-  SimpleScheduler::SchedulerJob.perform_now(args[:config_path])
+task simple_scheduler: :environment do
+  SimpleScheduler::SchedulerJob.perform_now
 end
 
 namespace :simple_scheduler do
   desc "Delete existing scheduled jobs and queue them from scratch"
-  task :reset, [:config_path] => [:environment] do |_, args|
+  task reset: :environment do
     SimpleScheduler::FutureJob.delete_all
-    SimpleScheduler::SchedulerJob.perform_now(args[:config_path])
+    SimpleScheduler::SchedulerJob.perform_now
   end
 end

metadata

@@ -1,139 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: simple_scheduler
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Brian Pattison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-04 00:00:00.000000000 Z
+date: 2017-11-17 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.0.14.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: An enhancement for Heroku Scheduler + Sidekiq for scheduling jobs at specific