resque-heroku-scaler 0.2.1 → 0.3.0

data/README.md

@@ -1,8 +1,8 @@
 Resque Heroku Scaler
 ====================
 
-Provides autoscaling for [Resque][rq] workers on [Heroku][hk]. Based on
-previous scaling work developed by [Daniel Huckstep][dh] and
+This [gem][rg] provides autoscaling for [Resque][rq] workers on [Heroku][hk].
+Based on previous scaling work developed by [Daniel Huckstep][dh] and
 [Alexander Murmann][am].
 
 Autoscaling behavior is provided through a separate monitor process. The
@@ -10,7 +10,14 @@ scaler monitor process polls for pending jobs against the specified Resque
 Redis backend at a configurable interval. The scaler process runs as a worker
 process on Heroku.
 
-##Setup
+Blog Post
+---------
+
+For details on the motivation behind using a separate scaler process, please
+see [this post][ad].
+
+Setup
+-----
 
 Add the following environment variables to your Heroku environment:
 
@@ -18,10 +25,19 @@ Add the following environment variables to your Heroku environment:
 * HEROKU_USERNAME
 * HEROKU_PASSWORD
 
+Include the scaler tasks in a file within lib/tasks (ex: lib/tasks/scaler.rake)
+
+```ruby
+require 'resque/tasks'
+require 'resque/plugins/heroku_scaler/tasks'
+
+task "resque:setup" => :environment
+```
+
 In your Procfile, configure the scaler as a worker process using:
 
 ```
-scaler: bundle exec rake resque:scaler:run
+scaler: bundle exec rake resque:heroku_scaler
 ```
 
 To run the scaler process, use the following command. Note, the scaler process
@@ -31,22 +47,40 @@ is intended to run as a single instance.
 heroku scale scaler=1
 ```
 
+Require the worker extensions within the app running the workers. For example,
+in lib/tasks/resque.rake.
+
+```ruby
+require 'resque/tasks'
+
+task "resque:setup" => :environment do
+  require 'resque-heroku-scaler'
+  ENV['QUEUE'] = '*'
+end
+```
+
 In your development environment, the scaler process can run local worker
-processes using the rush library. To configure, use the following in
-an initializer.
+processes using the rush library. To configure, update your scaler file in
+lib/tasks to use the local scale manager below (ex: lib/tasks/scaler.rake).
 
 ```ruby
-require 'resque/plugins/resque-heroku-scaler'
+require 'resque/tasks'
+require 'resque/plugins/heroku_scaler/tasks'
 
-if Rails.env.development?
-  ENV["RUSH_PATH"] ||= File.expand_path('/path/to/app', __FILE__)
-  Resque::Plugins::ResqueHerokuScaler.configure do |c|
-    c.scale_manager = :local
+task "resque:setup" => :environment do
+  if Rails.env.development?
+    require 'resque-heroku-scaler'
+    ENV["RUSH_PATH"] ||= File.expand_path('/path/to/app', __FILE__)
+    Resque::Plugins::HerokuScaler.configure do |c|
+      c.scale_manager = :local
+    end
   end
 end
 ```
 
+[rg]: http://rubygems.org/gems/resque-heroku-scaler
 [rq]: http://github.com/defunkt/resque
 [hk]: http://devcenter.heroku.com/articles/cedar
 [dh]: http://verboselogging.com/2010/07/30/auto-scale-your-resque-workers-on-heroku
-[am]: https://github.com/ajmurmann/resque-heroku-autoscaler
+[am]: http://github.com/ajmurmann/resque-heroku-autoscaler
+[ad]: http://www.dunnington.net/entry/autoscale-resque-workers-on-heroku

data/lib/resque-heroku-scaler.rb

@@ -0,0 +1 @@
+require 'resque/plugins/heroku_scaler'

data/lib/resque/plugins/{resque_heroku_scaler.rb → heroku_scaler.rb}

@@ -1,7 +1,14 @@
+require 'resque'
+require 'resque/plugins/heroku_scaler/version'
+require 'resque/plugins/heroku_scaler/config'
+require 'resque/plugins/heroku_scaler/manager'
+require 'resque/plugins/heroku_scaler/worker'
+require 'resque/plugins/heroku_scaler/resque'
+
 module Resque
   module Plugins
 
-    module ResqueHerokuScaler
+    module HerokuScaler
       class << self
 
         def run
@@ -39,23 +46,23 @@ module Resque
         end
 
         def wait_for_scale
-          sleep Resque::Plugins::ResqueHerokuScaler::Config.scale_interval
+          sleep Resque::Plugins::HerokuScaler::Config.scale_interval
         end
 
         def wait_for_workers
-          sleep Resque::Plugins::ResqueHerokuScaler::Config.poll_interval
+          sleep Resque::Plugins::HerokuScaler::Config.poll_interval
         end
 
         def scale_for(pending)
-          Resque::Plugins::ResqueHerokuScaler::Config.scale_for(pending)
+          Resque::Plugins::HerokuScaler::Config.scale_for(pending)
         end
 
         def scale_workers(qty)
-          Resque::Plugins::ResqueHerokuScaler::Manager.workers = qty
+          Resque::Plugins::HerokuScaler::Manager.workers = qty
         end
 
         def workers
-          Resque::Plugins::ResqueHerokuScaler::Manager.workers
+          Resque::Plugins::HerokuScaler::Manager.workers
         end
 
         def signal_workers
@@ -71,7 +78,7 @@ module Resque
         end
 
         def timeout
-          Time.now + Resque::Plugins::ResqueHerokuScaler::Config.scale_timeout
+          Time.now + Resque::Plugins::HerokuScaler::Config.scale_timeout
         end
 
         def pending
@@ -83,7 +90,7 @@ module Resque
         end
 
         def configure
-          yield Resque::Plugins::ResqueHerokuScaler::Config
+          yield Resque::Plugins::HerokuScaler::Config
         end
 
         def startup

data/lib/resque/plugins/{resque_heroku_scaler → heroku_scaler}/config.rb

@@ -1,6 +1,6 @@
 module Resque
   module Plugins
-    module ResqueHerokuScaler
+    module HerokuScaler
       module Config
         extend self
 

data/lib/resque/plugins/{resque_heroku_scaler → heroku_scaler}/manager.rb

@@ -1,6 +1,6 @@
 module Resque
   module Plugins
-    module ResqueHerokuScaler
+    module HerokuScaler
       module Manager
         extend self
 
@@ -9,7 +9,7 @@ module Resque
         end
 
         def init_manager
-          handler = Resque::Plugins::ResqueHerokuScaler::Config.scale_manager
+          handler = Resque::Plugins::HerokuScaler::Config.scale_manager
           return handler unless [Symbol, Array, String].include? handler.class
 
           options = {}

data/lib/resque/plugins/{resque_heroku_scaler → heroku_scaler}/manager/heroku.rb

@@ -2,7 +2,7 @@ require 'heroku'
 
 module Resque
   module Plugins
-    module ResqueHerokuScaler
+    module HerokuScaler
       module Manager
 
         class Heroku

data/lib/resque/plugins/{resque_heroku_scaler → heroku_scaler}/manager/local.rb

@@ -2,7 +2,7 @@ require 'rush'
 
 module Resque
   module Plugins
-    module ResqueHerokuScaler
+    module HerokuScaler
       module Manager
 
         class Local

data/lib/resque/plugins/heroku_scaler/tasks.rb

@@ -0,0 +1,9 @@
+require 'resque/tasks'
+
+namespace :resque do
+  desc "Start Resque Heroku Scaler process"
+  task :heroku_scaler => :setup do
+    require 'resque-heroku-scaler'
+    Resque::Plugins::HerokuScaler.run
+  end
+end

data/lib/resque/plugins/heroku_scaler/version.rb

@@ -0,0 +1,7 @@
+module Resque
+  module Plugins
+    module HerokuScaler
+      Version = VERSION = "0.3.0"
+    end
+  end
+end

data/test/config_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 class ConfigTest < MiniTest::Unit::TestCase
   def setup
-    @config = Resque::Plugins::ResqueHerokuScaler::Config
+    @config = Resque::Plugins::HerokuScaler::Config
   end
 
   def test_scale_manager_default

data/test/{resque_heroku_scaler_test.rb → heroku_scaler_test.rb}

@@ -1,9 +1,9 @@
 require 'test_helper'
 
-class ResqueHerokuScalerTest < MiniTest::Unit::TestCase
+class HerokuScalerTest < MiniTest::Unit::TestCase
   def setup
-    @scaler = Resque::Plugins::ResqueHerokuScaler
-    @config = Resque::Plugins::ResqueHerokuScaler::Config
+    @scaler = Resque::Plugins::HerokuScaler
+    @config = Resque::Plugins::HerokuScaler::Config
 
     @redis = mock('Mock Redis')
     @redis.stubs(:set).with(:scale, true).returns(true)
@@ -11,7 +11,7 @@ class ResqueHerokuScalerTest < MiniTest::Unit::TestCase
     Resque.stubs(:redis).returns(@redis)
 
     @manager = mock('Mock Manager')
-    Resque::Plugins::ResqueHerokuScaler::Manager.stubs(:instance).returns(@manager)
+    Resque::Plugins::HerokuScaler::Manager.stubs(:instance).returns(@manager)
   end
 
   def test_no_scale_for_zero_jobs

data/test/test_helper.rb

@@ -1,4 +1,4 @@
 require 'minitest/autorun'
 require 'mocha'
 require 'resque'
-require 'resque/plugins/resque-heroku-scaler'
+require 'resque-heroku-scaler'

metadata

@@ -2,7 +2,7 @@
 name: resque-heroku-scaler
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors: 
 - Aaron Dunnington
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-27 00:00:00 -05:00
+date: 2011-11-28 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,7 +35,7 @@ dependencies:
         version: 2.14.0
   type: :runtime
   version_requirements: *id002
-description: "    This gem provides autoscaling behavior for Resque jobs on Heroku.\n"
+description: "    This gem provides autoscaling for Resque workers on Heroku.\n"
 email: spirogh@gmail.com
 executables: []
 
@@ -48,18 +48,18 @@ files:
 - Rakefile
 - LICENSE
 - HISTORY.md
-- lib/resque/plugins/resque-heroku-scaler.rb
-- lib/resque/plugins/resque_heroku_scaler/config.rb
-- lib/resque/plugins/resque_heroku_scaler/manager/heroku.rb
-- lib/resque/plugins/resque_heroku_scaler/manager/local.rb
-- lib/resque/plugins/resque_heroku_scaler/manager.rb
-- lib/resque/plugins/resque_heroku_scaler/resque.rb
-- lib/resque/plugins/resque_heroku_scaler/tasks.rb
-- lib/resque/plugins/resque_heroku_scaler/version.rb
-- lib/resque/plugins/resque_heroku_scaler/worker.rb
-- lib/resque/plugins/resque_heroku_scaler.rb
+- lib/resque/plugins/heroku_scaler/config.rb
+- lib/resque/plugins/heroku_scaler/manager/heroku.rb
+- lib/resque/plugins/heroku_scaler/manager/local.rb
+- lib/resque/plugins/heroku_scaler/manager.rb
+- lib/resque/plugins/heroku_scaler/resque.rb
+- lib/resque/plugins/heroku_scaler/tasks.rb
+- lib/resque/plugins/heroku_scaler/version.rb
+- lib/resque/plugins/heroku_scaler/worker.rb
+- lib/resque/plugins/heroku_scaler.rb
+- lib/resque-heroku-scaler.rb
 - test/config_test.rb
-- test/resque_heroku_scaler_test.rb
+- test/heroku_scaler_test.rb
 - test/test_helper.rb
 - test/worker_test.rb
 has_rdoc: true

data/lib/resque/plugins/resque-heroku-scaler.rb

@@ -1,6 +0,0 @@
-require 'resque/plugins/resque_heroku_scaler/version'
-require 'resque/plugins/resque_heroku_scaler/config'
-require 'resque/plugins/resque_heroku_scaler/manager'
-require 'resque/plugins/resque_heroku_scaler/worker'
-require 'resque/plugins/resque_heroku_scaler/resque'
-require 'resque/plugins/resque_heroku_scaler'

data/lib/resque/plugins/resque_heroku_scaler/tasks.rb

@@ -1,11 +0,0 @@
-namespace :resque do
-  namespace :scaler do  
-    task :setup
-
-    desc "Start Resque Heroku Scaler process"
-    task :run => :setup do
-      require 'resque/plugins/resque-heroku-scaler'
-      Resque::Plugins::ResqueHerokuScaler.run
-    end
-  end
-end

data/lib/resque/plugins/resque_heroku_scaler/version.rb

@@ -1,7 +0,0 @@
-module Resque
-  module Plugins
-    module ResqueHerokuScaler
-      Version = VERSION = "0.2.1"
-    end
-  end
-end