n8-heroku-autoscale 0.2.2

data/README.md

@@ -0,0 +1,40 @@
+# Heroku::Autoscale
+
+This is a fork of @ddollar's original gem. It's a bit quick and dirty right now. 
+
+The main change I wanted to make was to have the scaling action this performs to be explicit. So instead of having code invoked on every single web request that this gem intercepts (it's a Rack app) which doesn't work for anyone that has multiple dynos going in production, you now have to explicitly ask your app to auto scale using a GET request to the app. 
+
+With that in place, you can issue that GET request from cron or clockwork or some alternative so that you don't have to worry about your autoscale commands running concurently. 
+
+## Installation
+
+    # Gemfile
+    gem 'heroku-autoscale', :git => "git@github.com:n8/heroku-autoscale.git"
+
+## Usage (Rails 2.x)
+
+    # config/environment.rb
+    use Heroku::Autoscale,
+      :username  => ENV["HEROKU_USERNAME"],
+      :password  => ENV["HEROKU_PASSWORD"],
+      :app_name  => ENV["HEROKU_APP_NAME"],
+    	:autoscale_key => ENV["HEROKU_SCALE_KEY"],
+      :min_dynos => 5,
+      :max_dynos => 30,
+      :queue_wait_low  => 100,  # milliseconds
+      :queue_wait_high => 1000, # milliseconds
+      :min_frequency   => 10    # seconds
+    
+## Usage (Rails 3 / Rack)
+
+    # config.ru
+    use Heroku::Autoscale,
+      :username  => ENV["HEROKU_USERNAME"],
+      :password  => ENV["HEROKU_PASSWORD"],
+      :app_name  => ENV["HEROKU_APP_NAME"],
+    	:autoscale_key => ENV["HEROKU_SCALE_KEY"],
+      :min_dynos => 5,
+      :max_dynos => 30,
+      :queue_wait_low  => 100,  # milliseconds
+      :queue_wait_high => 1000, # milliseconds
+      :min_frequency   => 10    # seconds

data/Rakefile

@@ -0,0 +1,59 @@
+require "rake"
+require "rspec"
+require "rspec/core/rake_task"
+
+$:.unshift File.expand_path("../lib", __FILE__)
+require "heroku/autoscale"
+
+task :default => :spec
+
+desc "Run all specs"
+Rspec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+desc "Generate RCov code coverage report"
+task :rcov => "rcov:build" do
+  %x{ open coverage/index.html }
+end
+
+Rspec::Core::RakeTask.new("rcov:build") do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rcov = true
+  t.rcov_opts = [ "--exclude", Gem.default_dir , "--exclude", "spec" ]
+end
+
+######################################################
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name    = "heroku-autoscale"
+    s.version = Heroku::Autoscale::VERSION
+
+    s.summary     = "Autoscale your Heroku dynos"
+    s.description = s.summary
+    s.author      = "David Dollar"
+    s.email       = "ddollar@gmail.com"
+    s.homepage    = "http://github.com/ddollar/heroku-autoscale"
+
+    s.platform = Gem::Platform::RUBY
+    s.has_rdoc = false
+
+    s.files = %w(Rakefile README.md) + Dir["{bin,export,lib,spec}/**/*"]
+    s.require_path = "lib"
+
+    s.add_development_dependency 'rack-test', '~> 0.5.4'
+    s.add_development_dependency 'rake',      '~> 0.8.7'
+    s.add_development_dependency 'rcov',      '~> 0.9.8'
+    s.add_development_dependency 'rr',        '~> 0.10.11'
+    s.add_development_dependency 'rspec',     '~> 2.0.0'
+
+    s.add_dependency 'eventmachine'
+    s.add_dependency 'heroku', '~> 1.9'
+    s.add_dependency 'rack',   '~> 1.0'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end

data/lib/heroku/autoscale.rb

@@ -0,0 +1,85 @@
+require "eventmachine"
+require "heroku"
+require "rack"
+
+module Heroku
+  class Autoscale
+
+    VERSION = "0.2.2"
+
+    attr_reader :app, :options, :last_scaled
+
+    def initialize(app, options={})
+      @app = app
+      @options = default_options.merge(options)
+      @last_scaled = Time.now - 60
+      check_options!
+    end
+
+    def call(env)
+      if env["PATH_INFO"] == "/autoscale/#{options[:autoscale_key]}"
+        autoscale env
+        [200, {'Content-Type' => 'text/plain'}, ["Current wait time: #{env["HTTP_X_HEROKU_QUEUE_WAIT_TIME"]}"]]
+      else
+        app.call(env)
+      end 
+    end
+
+private ######################################################################
+
+    def autoscale(env)
+      # dont do anything if we scaled too frequently ago
+      return if (Time.now - last_scaled) < options[:min_frequency]
+
+      original_dynos = dynos = current_dynos
+      wait = queue_wait(env)
+
+      dynos -= 1 if wait <= options[:queue_wait_low]
+      dynos += 1 if wait >= options[:queue_wait_high]
+
+      dynos = options[:min_dynos] if dynos < options[:min_dynos]
+      dynos = options[:max_dynos] if dynos > options[:max_dynos]
+      dynos = 1 if dynos < 1
+
+      set_dynos(dynos) if dynos != original_dynos
+    end
+
+    def check_options!
+      errors = []
+      errors << "Must supply :username to Heroku::Autoscale" unless options[:username]
+      errors << "Must supply :password to Heroku::Autoscale" unless options[:password]
+      errors << "Must supply :app_name to Heroku::Autoscale" unless options[:app_name]
+      raise errors.join(" / ") unless errors.empty?
+    end
+
+    def current_dynos
+      # heroku.info(options[:app_name])[:dynos].to_i
+      heroku.ps(options[:app_name]).select{|jobby| jobby['process'].index("web.") != nil}.size
+    end
+
+    def default_options
+      {
+        :defer           => true,
+        :min_dynos       => 1,
+        :max_dynos       => 1,
+        :queue_wait_high => 5000, # milliseconds
+        :queue_wait_low  => 0,    # milliseconds
+        :min_frequency   => 10    # seconds
+      }
+    end
+
+    def heroku
+      @heroku ||= Heroku::Client.new(options[:username], options[:password])
+    end
+
+    def queue_wait(env)
+      env["HTTP_X_HEROKU_QUEUE_WAIT_TIME"].to_i
+    end
+
+    def set_dynos(count)
+      heroku.ps_scale(options[:app_name], :type => 'web', :qty => count)
+      @last_scaled = Time.now
+    end
+
+  end
+end

data/spec/heroku/autoscale_spec.rb

@@ -0,0 +1,97 @@
+require "spec_helper"
+require "heroku/autoscale"
+
+describe Heroku::Autoscale do
+
+  include Rack::Test::Methods
+
+  def noop
+    lambda {}
+  end
+
+  describe "option validation" do
+    it "requires username" do
+      lambda { Heroku::Autoscale.new(noop) }.should raise_error(/Must supply :username/)
+    end
+
+    it "requires password" do
+      lambda { Heroku::Autoscale.new(noop) }.should raise_error(/Must supply :password/)
+    end
+
+    it "requires app_name" do
+      lambda { Heroku::Autoscale.new(noop) }.should raise_error(/Must supply :app_name/)
+    end
+  end
+
+  describe "with valid options" do
+    let(:app) do
+      Heroku::Autoscale.new noop,
+        :defer => false,
+        :username => "test_username",
+        :password => "test_password",
+        :app_name => "test_app_name",
+        :min_dynos       => 1,
+        :max_dynos       => 10,
+        :queue_wait_low  => 10,
+        :queue_wait_high => 100,
+        :min_frequency   => 10
+    end
+
+    it "scales up" do
+      heroku = mock(Heroku::Client)
+      heroku.info("test_app_name") { { :dynos => 1 } }
+      heroku.set_dynos("test_app_name", 2)
+
+      mock(app).heroku.times(any_times) { heroku }
+      app.call({ "HTTP_X_HEROKU_QUEUE_WAIT_TIME" => 101 })
+    end
+
+    it "scales down" do
+      heroku = mock(Heroku::Client)
+      heroku.info("test_app_name") { { :dynos => 3 } }
+      heroku.set_dynos("test_app_name", 2)
+
+      mock(app).heroku.times(any_times) { heroku }
+      app.call({ "HTTP_X_HEROKU_QUEUE_WAIT_TIME" => 9 })
+    end
+
+    it "wont go below one dyno" do
+      heroku = mock(Heroku::Client)
+      heroku.info("test_app_name") { { :dynos => 1 } }
+      heroku.set_dynos.times(0)
+
+      mock(app).heroku.times(any_times) { heroku }
+      app.call({ "HTTP_X_HEROKU_QUEUE_WAIT_TIME" => 9 })
+    end
+
+    it "respects max dynos" do
+      heroku = mock(Heroku::Client)
+      heroku.info("test_app_name") { { :dynos => 10 } }
+      heroku.set_dynos.times(0)
+
+      mock(app).heroku.times(any_times) { heroku }
+      app.call({ "HTTP_X_HEROKU_QUEUE_WAIT_TIME" => 101 })
+    end
+
+    it "respects min dynos" do
+      app.options[:min_dynos] = 2
+      heroku = mock(Heroku::Client)
+      heroku.info("test_app_name") { { :dynos => 2 } }
+      heroku.set_dynos.times(0)
+
+      mock(app).heroku.times(any_times) { heroku }
+      app.call({ "HTTP_X_HEROKU_QUEUE_WAIT_TIME" => 9 })
+    end
+
+    it "doesnt flap" do
+      heroku = mock(Heroku::Client)
+      heroku.info("test_app_name").once { { :dynos => 5 } }
+      heroku.set_dynos.with_any_args.once
+
+      mock(app).heroku.times(any_times) { heroku }
+      app.call({ "HTTP_X_HEROKU_QUEUE_WAIT_TIME" => 9 })
+      app.call({ "HTTP_X_HEROKU_QUEUE_WAIT_TIME" => 9 })
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require "rubygems"
+require "rack/test"
+require "rspec"
+
+$:.unshift "lib"
+
+Rspec.configure do |config|
+  config.color_enabled = true
+  config.mock_with :rr
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: n8-heroku-autoscale
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+  prerelease: 
+platform: ruby
+authors:
+- David Dollar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2010-07-09 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &70193737265220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+  type: :development
+  prerelease: false
+  version_requirements: *70193737265220
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70193737264740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: *70193737264740
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &70193737264260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+  type: :development
+  prerelease: false
+  version_requirements: *70193737264260
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: &70193737263780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.11
+  type: :development
+  prerelease: false
+  version_requirements: *70193737263780
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70193737263300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70193737263300
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: &70193737262820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70193737262820
+- !ruby/object:Gem::Dependency
+  name: heroku
+  requirement: &70193737262280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70193737262280
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &70193737261740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70193737261740
+description: Autoscale your Heroku dynos
+email: ddollar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- Rakefile
+- lib/heroku/autoscale.rb
+- spec/heroku/autoscale_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ddollar/heroku-autoscale
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Autoscale your Heroku dynos
+test_files:
+- spec/heroku/autoscale_spec.rb
+- spec/spec_helper.rb