resque-scheduler 2.5.3 → 2.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c05f1351c925cc303b776e6350b5930ae402f49e
-  data.tar.gz: 6bf4cb27cb0c669d39eb1b645f0cd6fad6f103fd
+  metadata.gz: 7e0ce99a734298a549762b23f47785be5667966a
+  data.tar.gz: 6afeb5b9d56d492974e546a5f02b07e5a187de29
 SHA512:
-  metadata.gz: 1cb052b2a716d465e6e3726ca9e287b5b06a8d74f28a2f3bf9507aa6ab896816c0b64f02c013db6350b0c63f3f307434fe012e9837a0b142816bec23f0d517dc
-  data.tar.gz: 7bdd9f1bafceee0773e99c6bc22621d84d37a6bca2894250d33157c0d4a308e03c800c02445a713afd2b1f6a7312d0ec97460496639186ffb48b922219badb8e
+  metadata.gz: ca01e37f6f95d63381c991e15334886882b1a0ec3808235fc8d4e2b388c2fb27540d5656900e5b65a73b199436d638b393ec02431a198ce338407a7490f2e776
+  data.tar.gz: 84d9c9d293009c89ddbb7362d1741ceef87f74fd31636c1631c7a1ce731eb4fbf118263f92ab2af393dfd3898fb8de6ec94bbf208940ed15213c07104c974442

data/HISTORY.md

@@ -1,5 +1,8 @@
 # Resque Scheduler History / ChangeLog / Release Notes
 
+## 2.5.4 (2014-02-17)
+* Documentation updates
+
 ## 2.5.3 (2014-02-12)
 * Handling signals during poll sleep
 

data/README.md

@@ -55,13 +55,12 @@ Adding the resque:scheduler rake task:
 require 'resque_scheduler/tasks'
 ```
 
-There are three things `resque-scheduler` needs to know about in order to do
-it's jobs: the schedule, where redis lives, and which queues to use.  The
-easiest way to configure these things is via the rake task.  By default,
-`resque-scheduler` depends on the "resque:setup" rake task.  Since you
-probably already have this task, lets just put our configuration there.
-`resque-scheduler` pretty much needs to know everything `resque` needs
-to know.
+### Rake integration
+
+By default, `resque-scheduler` depends on the "resque:setup" rake task.
+Since you probably already have this task, lets just put our
+configuration there.  `resque-scheduler` pretty much needs to know
+everything `resque` needs to know.
 
 ```ruby
 # Resque tasks
@@ -82,7 +81,7 @@ namespace :resque do
     # When dynamic is set to true, the scheduler process looks for
     # schedule changes and applies them on the fly.
     # Note: This feature is only available in >=2.0.0.
-    #Resque::Scheduler.dynamic = true
+    # Resque::Scheduler.dynamic = true
 
     # The schedule doesn't need to be stored in a YAML, it just needs to
     # be a hash.  YAML is usually the easiest.
@@ -98,21 +97,58 @@ namespace :resque do
 end
 ```
 
-The scheduler process is just a rake task which is responsible for both
-queueing items from the schedule and polling the delayed queue for items
-ready to be pushed on to the work queues.  For obvious reasons, this process
-never exits.
+The scheduler rake task is responsible for both queueing items from the
+schedule and polling the delayed queue for items ready to be pushed on
+to the work queues.  For obvious reasons, this process never exits.
 
-    $ rake resque:scheduler
+``` bash
+rake resque:scheduler
+```
 
 or, if you want to load the environment first:
 
-    $ rake environment resque:scheduler
+``` bash
+rake environment resque:scheduler
+```
+
+
+### Standalone Executable
+
+The scheduler may also be run via a standalone `resque-scheduler`
+executable, which will be available once the gem is installed.
+
+``` bash
+# Get some help
+resque-scheduler --help
+```
+
+The executable accepts options via option flags as well as via
+[environment variables](#environment-variables).
+
+### Environment Variables
+
+Both the Rake task and standalone executable support the following
+environment variables:
+
+* `APP_NAME` - Application name used in procline (`$0`) (default empty)
+* `BACKGROUND` - [Run in the background](#running-in-the-background) if
+non-empty (via `Process.daemon`, if supported) (default `false`)
+* `DYNAMIC_SCHEDULE` - Enables [dynamic scheduling](#dynamic-schedules)
+if non-empty (default `false`)
+* `RAILS_ENV` - Environment to use in procline (`$0`) (default empty)
+* `INITIALIZER_PATH` - Path to a Ruby file that will be loaded *before*
+requiring `resque` and `resque/scheduler` (default empty).
+* `RESQUE_SCHEDULER_INTERVAL` - Interval in seconds for checking if a
+scheduled job must run (coerced with `Kernel#Float()`) (default `5`)
+* `LOGFILE` - Log file name (default empty, meaning `$stdout`)
+* `LOGFORMAT` - Log output format to use (either `'text'` or `'json'`,
+default `'text'`)
+* `PIDFILE` - If non-empty, write process PID to file (default empty)
+* `QUIET` or `MUTE` - Silence most output if non-empty (equivalent to
+a level of `Logger::FATAL`, default `false`)
+* `VERBOSE` - Maximize log verbosity if non-empty (equivalent to a level
+of `Logger::DEBUG`, default `false`)
 
-Supported environment variables are `VERBOSE` and `MUTE`.  If either is set to
-any nonempty value, they will take effect.  `VERBOSE` simply dumps more output
-to stdout.  `MUTE` does the opposite and silences all output. `MUTE`
-supersedes `VERBOSE`.
 
 ### Resque Pool integration 
 

data/lib/resque_scheduler/version.rb

@@ -1,5 +1,5 @@
 # vim:fileencoding=utf-8
 
 module ResqueScheduler
-  VERSION = '2.5.3'
+  VERSION = '2.5.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resque-scheduler
 version: !ruby/object:Gem::Version
-  version: 2.5.3
+  version: 2.5.4
 platform: ruby
 authors:
 - Ben VandenBos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-12 00:00:00.000000000 Z
+date: 2014-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -241,7 +241,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Light weight job scheduling on top of Resque