resque-heroku-autoscaler 0.1.0

data/GEMFILE

@@ -0,0 +1,12 @@
+source 'http://rubygems.org'
+
+gem 'resque', '>= 1.8'
+gem 'heroku', '1.11.0'
+
+group :development do
+  gem "rspec", "~> 2.0"
+  gem 'rr', '1.0.2'
+  gem 'echoe'
+  gem 'rake'
+end
+

data/MIT.LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Alexander Murmann
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+Resque Heroku Autoscaler
+===========
+
+A [Resque][rq] plugin. Requires Resque 1.8 and the Heroku gem (I only testet with 1.11.0).
+
+This gem scales your Heroku workers according to the number of pending Resque jobs. The original idea comes from Daniel Huckstep's [blog post on the topic][dh]
+
+Just extend your job class with esque::Plugins::HerokuAutoscaler.
+
+
+For example:
+
+    require 'resque/plugins/heroku_autoscaler'
+
+    class TestJob
+      extend Resque::Plugins::HerokuAutoscaler
+
+      @queue = :test
+
+      def
+    end
+
+When you add the job to your Resque queue, a new worker will be started if there isn't already one. If all jobs in the queue are processed the worker will be stopped again, keeping your costs low.
+
+Currently there is no way build in to set how many workers to are being started. I plan on adding that functionality soon.
+
+[dh]: http://blog.darkhax.com/2010/07/30/auto-scale-your-resque-workers-on-heroku
+[rq]: http://github.com/defunkt/resque

data/lib/resque/plugins/resque_heroku_autoscaler.rb

@@ -0,0 +1,23 @@
+module Resque
+  module Plugins
+    module HerokuAutoscaler
+      @@heroku_client = nil
+
+      def after_enqueue_scale_workers_up(*args)
+        set_workers(1)
+      end
+
+      def after_perform_scale_workers_down(*args)
+        set_workers(0) if Resque.info[:pending] == 0
+      end
+
+      def set_workers(number_of_workers)
+        heroku_client.set_workers(ENV['HEROKU_APP'], number_of_workers)
+      end
+
+      def heroku_client
+        @@heroku_client || @@heroku_client = Heroku::Client.new(ENV['HEROKU_USER'], ENV['HEROKU_PASS'])
+      end
+    end
+  end
+end

data/spec/resque_heroku_autoscaler_spec.rb

@@ -0,0 +1,119 @@
+require 'rspec'
+require 'heroku'
+require 'resque'
+require 'resque/plugins/resque_heroku_autoscaler'
+
+class TestJob
+  extend Resque::Plugins::HerokuAutoscaler
+
+  @queue = :test
+end
+
+class AnotherJob
+  extend Resque::Plugins::HerokuAutoscaler
+
+  @queue = :test
+end
+
+RSpec.configure do |config|
+  config.mock_with :rr
+end
+
+describe Resque::Plugins::HerokuAutoscaler do
+  it "should be a valid Resque plugin" do
+    lambda { Resque::Plugin.lint(Resque::Plugins::HerokuAutoscaler) }.should_not raise_error
+  end
+
+  describe ".after_enqueue_scale_workers_up" do
+    it "should add the hook" do
+      Resque::Plugin.after_enqueue_hooks(TestJob).should include("after_enqueue_scale_workers_up")
+    end
+
+    it "should take whatever args Resque hands in" do
+      stub(Heroku::Client).new { stub!.set_workers }
+
+      lambda { TestJob.after_enqueue_scale_workers_up("some", "random", "aguments", 42) }.should_not raise_error
+    end
+
+    it "should create one worker" do
+      stub(TestJob).workers { 0 }
+      mock(TestJob).set_workers(1)
+      TestJob.after_enqueue_scale_workers_up
+    end
+  end
+
+  describe ".after_perform_scale_workers_down" do
+
+    it "should add the hook" do
+      Resque::Plugin.after_hooks(TestJob).should include("after_perform_scale_workers_down")
+    end
+
+    it "should take whatever args Resque hands in" do      
+      Resque::Plugins::HerokuAutoscaler.class_eval("@@heroku_client = nil")
+      stub(Heroku::Client).new { stub!.set_workers }
+
+      lambda { TestJob.after_perform_scale_workers_down("some", "random", "aguments", 42) }.should_not raise_error
+    end
+
+    context "when the queue is empty" do
+      before do
+        stub(Resque).info { {:pending => 0} }
+      end
+
+      it "should set workers to 0" do
+        mock(TestJob).set_workers(0)
+        TestJob.after_perform_scale_workers_down
+      end
+    end
+
+    context "when the queue is not empty" do
+      before do
+        stub(Resque).info { {:pending => 1} }
+      end
+
+      it "should not change workers" do
+        dont_allow(TestJob).set_workers
+        TestJob.after_perform_scale_workers_down
+      end
+    end
+  end
+
+  describe ".set_workers" do
+    it "should use the Heroku client to set the workers" do
+      ENV['HEROKU_APP'] = 'some app name'
+      mock(TestJob).heroku_client { mock!.set_workers('some app name', 10) }
+      TestJob.set_workers(10)
+    end
+  end
+
+  describe ".heroku_client" do
+    before do
+      ENV['HEROKU_USER'] = 'john doe'
+      ENV['HEROKU_PASS'] = 'password'
+    end
+
+    it "should return a heroku client" do
+      Resque::Plugins::HerokuAutoscaler.class_eval("@@heroku_client = nil")
+      TestJob.heroku_client.should be_a(Heroku::Client)
+    end
+
+    it "should use the right username and password" do
+      Resque::Plugins::HerokuAutoscaler.class_eval("@@heroku_client = nil")
+      mock(Heroku::Client).new('john doe', 'password')
+      TestJob.heroku_client
+    end
+
+    it "should return the same client for multiple jobs" do
+      a = 0
+      stub(Heroku::Client).new { a += 1 }
+      TestJob.heroku_client.should == TestJob.heroku_client
+    end
+
+    it "should share the same client across differnet job types" do
+      a = 0
+      stub(Heroku::Client).new { a += 1 }
+
+      TestJob.heroku_client.should == AnotherJob.heroku_client
+    end
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: resque-heroku-autoscaler
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Alexander Murmann
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-06 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: resque
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 8
+        version: "1.8"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: heroku
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: 
+email: ajmurmann@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- MIT.LICENSE
+- GEMFILE
+- lib/resque/plugins/resque_heroku_autoscaler.rb
+- spec/resque_heroku_autoscaler_spec.rb
+has_rdoc: true
+homepage: https://github.com/ajmurmann/resque-heroku-autoscaler
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Resque plugin to autoscale your workers on Heroku
+test_files: []
+