sidekiq-scheduler 2.0.7 → 2.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d0589167bd1d704cc531881f41ce934e07e684a
-  data.tar.gz: 4a07798d84026cedbb746d6c455463ae796ca56f
+  metadata.gz: a2ca5f12c843c8653e3a174431625f89622daee3
+  data.tar.gz: e479e32ea285d53200078971da9b1eb3e7dfd323
 SHA512:
-  metadata.gz: 56218d97eb155af5fbf07e4ccbca6a5e76bfe5e23facefb8e685758d3f031b17ab6f66ed89132a8953a8b03ad3935132cb1eefedbf3adbb2d23168698c4b959a
-  data.tar.gz: 722247865b66c237efcea76d099207b746e5058adeb60a550a8090baec5c666dab01f7659a8c00d3021fa9138692eccde02b62343980b3da2f9cfab5b2d4a0de
+  metadata.gz: 2ab648c207104060b36cfebb38fae68bb8af05b63ab2760485d6b958e1145312b7b1ceca631089eb297d8a84f6963969920e04f36e5fc9f641f45635b58d5c10
+  data.tar.gz: ef5e376ba307b8b0fc62c6fcb61b7be50c50cd37971715e501de8220dad7e8743dfb5856ba18c10aa963c990827d194b807df2fe45927a38c3027aa7310a247b

data/README.md

@@ -25,45 +25,49 @@
   </a>
 </p>
 
-sidekiq-scheduler is an extension to [Sidekiq](http://github.com/mperham/sidekiq)
-that adds support for running scheduled.
-
-Scheduled jobs are like cron jobs, recurring on a regular basis.
+sidekiq-scheduler is an extension to [Sidekiq](http://github.com/mperham/sidekiq) that adds support
+for running scheduled jobs, which are like cron jobs, recurring on a regular basis.
 
 ## Installation
 
 Add this to your Gemfile:
+
 ```ruby
 gem 'sidekiq-scheduler', '~> 2.0'
-```
+  ```
 
-If you are using rails you are set
+If you are using Rails you are set.
+
+If you are not using Rails create a file with this content:
 
-If you are not using rails create a file with this content:
 ```ruby
 require 'sidekiq-scheduler'
-```
+  ```
+
+and then execute:
 
-and the execute:
 ```sh
 sidekiq -r created_file_path.rb
-```
+  ```
 
 Look at [Loading the schedule](https://github.com/moove-it/sidekiq-scheduler/#loading-the-schedule)
 for information on how to load your schedule.
 
-You can add sidekiq-scheduler configuration options to sidekiq.yml config file.
+You can add sidekiq-scheduler configuration options to `sidekiq.yml` config file.
 Available options are:
 
-    :schedule: <the schedule to be run>
-    :dynamic: <if true the schedule can be modified in runtime [false by default]>
-    :enabled: <enables scheduler if true [true by default]>
-    :scheduler:
-      :listened_queues_only: <push jobs whose queue is being listened by sidekiq [false by default]>
+``` yaml
+:schedule: <the schedule to be run>
+:dynamic: <if true the schedule can be modified in runtime [false by default]>
+:enabled: <enables scheduler if true [true by default]>
+:scheduler:
+  :listened_queues_only: <push jobs whose queue is being listened by sidekiq [false by default]>
+```
 
 ## Manage tasks from Unicorn/Rails server
 
-For example, if you want start sidekiq-scheduler only from Unicorn/Rails, but not from Sidekiq you can write something like this in initializer:
+If you want start sidekiq-scheduler only from Unicorn/Rails, but not from Sidekiq you can have
+something like this in an initializer:
 
 ```ruby
 # config/initializers/sidekiq_scheduler.rb
@@ -91,46 +95,52 @@ end
 ## Scheduled Jobs (Recurring Jobs)
 
 Scheduled (or recurring) jobs are logically no different than a standard cron
-job.  They are jobs that run based on a fixed schedule which is set at
+job. They are jobs that run based on a fixed schedule which is set at
 startup.
 
 The schedule is a list of Sidekiq worker classes with arguments and a
-schedule frequency (in crontab syntax).  The schedule is just a hash, but
-is most likely stored in a YAML like so:
-
-    CancelAbandonedOrders:
-      cron: "*/5 * * * *"
-
-    queue_documents_for_indexing:
-      cron: "0 0 * * *"
-      # you can use rufus-scheduler "every" syntax in place of cron if you prefer
-      # every: 1h
-      # By default the job name (hash key) will be taken as worker class name.
-      # If you want to have a different job name and class name, provide the 'class' option
-      class: QueueDocuments
-      queue: high
-      args:
-      description: "This job queues all content for indexing in solr"
-
-    clear_leaderboards_contributors:
-      cron: "30 6 * * 1"
-      class: ClearLeaderboards
-      queue: low
-      args: contributors
-      description: "This job resets the weekly leaderboard for contributions"
-
-You can provide options to "every" or "cron" via Array:
-
-    clear_leaderboards_moderator:
-      every: ["30s", :first_in => '120s']
-      class: CheckDaemon
-      queue: daemons
-      description: "This job will check Daemon every 30 seconds after 120 seconds after start"
+schedule frequency (in crontab syntax). The schedule is just a Hash, being most likely
+stored in a YAML like so:
+
+``` yaml
+  CancelAbandonedOrders:
+    cron: "*/5 * * * *"
+
+  queue_documents_for_indexing:
+    cron: "0 0 * * *"
+    # you can use rufus-scheduler "every" syntax in place of cron if you prefer
+    # every: 1h
+
+    # By default the job name (Hash key) will be taken as worker class name.
+    # If you want to have a different job name and class name, provide the 'class' option
+    class: QueueDocuments
+
+    queue: high
+    args:
+    description: "This job queues all content for indexing in solr"
+
+  clear_leaderboards_contributors:
+    cron: "30 6 * * 1"
+    class: ClearLeaderboards
+    queue: low
+    args: contributors
+    description: "This job resets the weekly leaderboard for contributions"
+```
+
+You can provide options to `every` or `cron` via an Array:
+
+``` yaml
+  clear_leaderboards_moderator:
+    every: ["30s", :first_in => '120s']
+    class: CheckDaemon
+    queue: daemons
+    description: "This job will check Daemon every 30 seconds after 120 seconds after start"
+```
 
 
 NOTE: Six parameter cron's are also supported (as they supported by
 rufus-scheduler which powers the sidekiq-scheduler process).  This allows you
-to schedule jobs per second (ie: "30 * * * * *" would fire a job every 30
+to schedule jobs per second (ie: `30 * * * * *` would fire a job every 30
 seconds past the minute).
 
 A big shout out to [rufus-scheduler](http://github.com/jmettraux/rufus-scheduler)
@@ -139,8 +149,8 @@ for handling the heavy lifting of the actual scheduling engine.
 
 ### Loading the schedule
 
-Let's assume your scheduled jobs are defined in a file called "config/scheduler.yml" under your Rails project,
-you could create a Rails initializer called "config/initializers/scheduler.rb" which would load the job definitions:
+Let's assume your scheduled jobs are defined in a file called `config/scheduler.yml` under your Rails project,
+you could create a Rails initializer called `config/initializers/scheduler.rb` which would load the job definitions:
 
 ```ruby
 require 'sidekiq/scheduler'
@@ -153,7 +163,7 @@ Sidekiq.configure_server do |config|
 end
 ```
 
-If you were running a non Rails project you should add code to load the workers classes before loading the schedule.
+If you are running a non Rails project you should add code to load the workers classes before loading the schedule.
 
 ```ruby
 require 'sidekiq/scheduler'
@@ -197,12 +207,14 @@ When `:dynamic` flag is set to `true`, schedule changes are loaded every 5 secon
 
 You can set that flag in the following ways.
 
-- Yaml configuration:
+- YAML configuration:
+
 ```
 :dynamic: true
 ```
 
 - Initializer configuration:
+
 ```ruby
 Sidekiq.configure_server do |config|
   # ...
@@ -216,25 +228,30 @@ end
 
 If `:dynamic` flag is set to false, you have to reload the schedule manually in sidekiq
 side:
+
 ```ruby
 Sidekiq::Scheduler.reload_schedule!
 ```
 
-If the schedule did not exist it'll we created, if it existed it'll be updated
+If the schedule did not exist it will we created, if it existed it will be updated.
 
 ### Testing
 
- In your tests you can check that a schedule change has been set you have to:
- ```ruby
-   require 'sidekiq'
-   require 'sidekiq-scheduler'
-   require 'sidekiq-scheduler/test'
+In your tests you can check that a schedule change has been set you have to:
 
-   Sidekiq.set_schedule('some_name', { 'every' => ['1m'], 'class' => 'HardWorker' })
+```ruby
+require 'sidekiq'
+require 'sidekiq-scheduler'
+require 'sidekiq-scheduler/test'
 
-   Sidekiq::Scheduler.schedules => { 'every' => ['1m'], 'class' => 'HardWorker' }
-   Sidekiq::Scheduler.schedules_changed => ['every']
- ```
+Sidekiq.set_schedule('some_name', { 'every' => ['1m'], 'class' => 'HardWorker' })
+
+Sidekiq::Scheduler.schedules
+#  => { 'every' => ['1m'], 'class' => 'HardWorker' }
+
+Sidekiq::Scheduler.schedules_changed
+#  => ['every']
+```
 
 
 ### Time zones
@@ -244,13 +261,17 @@ rather than the `config.time_zone` specified in Rails.
 
 You can explicitly specify the time zone that rufus-scheduler will use:
 
-    cron: "30 6 * * 1 Europe/Stockholm"
+``` yaml
+cron: "30 6 * * 1 Europe/Stockholm"
+```
 
 Also note that `config.time_zone` in Rails allows for a shorthand (e.g. "Stockholm")
 that rufus-scheduler does not accept. If you write code to set the scheduler time zone
 from the `config.time_zone` value, make sure it's the right format, e.g. with:
 
-    ActiveSupport::TimeZone.find_tzinfo(Rails.configuration.time_zone).name
+``` ruby
+ActiveSupport::TimeZone.find_tzinfo(Rails.configuration.time_zone).name
+```
 
 A future version of sidekiq-scheduler may do this for you.
 
@@ -258,7 +279,7 @@ A future version of sidekiq-scheduler may do this for you.
 
 SidekiqScheduler provides an extension to the Sidekiq web interface that adds a Recurring Jobs page.
 
-To use it, set up the Sidekiq web interface according to the Sidekiq documentation and then add the SidekiqScheduler::Web require:
+To use it, set up the Sidekiq web interface according to the Sidekiq documentation and then add the `sidekiq-scheduler/web` require:
 
 ``` ruby
 require 'sidekiq/web'
@@ -269,10 +290,10 @@ require 'sidekiq-scheduler/web'
 
 * Fork the project.
 * Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+* Add tests for it. This is important so it won't break it in a future version unintentionally.
+* Commit, do not mess with version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself so it can be ignored when merging)
+* Send a pull request. Bonus points for topic branches.
 
 ## Credits
 

data/lib/sidekiq-scheduler/version.rb

@@ -1,5 +1,5 @@
 module SidekiqScheduler
 
-  VERSION = '2.0.7'
+  VERSION = '2.0.8'
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-scheduler
 version: !ruby/object:Gem::Version
-  version: 2.0.7
+  version: 2.0.8
 platform: ruby
 authors:
 - Morton Jonuschat
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-20 00:00:00.000000000 Z
+date: 2016-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -169,16 +169,16 @@ dependencies:
   name: activejob
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement