heroku-scalr 0.1.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    heroku-scalr (0.1.0)
+      heroku-api (~> 0.3.8)
+      timers
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.4)
+    crack (0.3.2)
+    diff-lcs (1.2.4)
+    excon (0.20.1)
+    heroku-api (0.3.9)
+      excon (~> 0.20.1)
+    rake (10.0.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    timers (1.1.0)
+    webmock (1.11.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+    yard (0.8.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  heroku-scalr!
+  rake
+  rspec
+  webmock
+  yard

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake'
+
+require 'rspec/mocks/version'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'yard'
+YARD::Rake::YardocTask.new
+
+desc 'Default: run specs.'
+task :default => :spec

data/bin/heroku-scalr

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require "heroku/scalr/cli"
+Heroku::Scalr::CLI.run!

data/heroku-scalr.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.required_ruby_version = '>= 1.9.1'
+  s.required_rubygems_version = ">= 1.8.0"
+
+  s.name        = File.basename(__FILE__, '.gemspec')
+  s.summary     = "Watch and scale your dynos!"
+  s.description = "Issues recurring 'pings' to your Heroku apps and scales dynos up or down depending on pre-defined rules"
+  s.version     = "0.1.0"
+
+  s.authors     = ["Black Square Media"]
+  s.email       = "info@blacksquaremedia.com"
+  s.homepage    = "https://github.com/bsm/heroku-scalr"
+
+  s.require_path = 'lib'
+  s.executables  = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.files        = `git ls-files`.split("\n")
+  s.test_files   = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  s.add_dependency "timers"
+  s.add_dependency "heroku-api", '~> 0.3.8'
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "yard"
+  s.add_development_dependency "webmock"
+end

data/lib/heroku/scalr/app.rb

@@ -0,0 +1,123 @@
+class Heroku::Scalr::App
+
+  DEFAULTS = {
+    interval: 30,
+    min_dynos: 1,
+    max_dynos: 2,
+    wait_low: 10,
+    wait_high: 100,
+    min_frequency: 60
+  }.freeze
+
+  attr_reader :name, :http, :api, :interval, :min_dynos, :max_dynos,
+              :wait_low, :wait_high, :min_frequency, :last_scaled_at
+
+  # @param [String] name Heroku app name
+  # @param [Hash] opts options
+  # @option opts [Integer] :interval
+  #   perform checks every `interval` seconds, default: 60
+  # @option opts [Integer] :min_dynos
+  #   the minimum number of dynos, default: 1
+  # @option opts [Integer] :max_dynos
+  #   the maximum number of dynos, default: 2
+  # @option opts [Integer] :wait_low
+  #   lowers the number of dynos if queue wait time is less than `wait_low` ms, default: 10
+  # @option opts [Integer] :wait_high
+  #   lowers the number of dynos if queue wait time is more than `wait_high` ms, default: 100
+  # @option opts [Integer] :min_frequency
+  #   leave at least `min_frequency` seconds before scaling again, default: 60
+  # @option opts [String] :api_key
+  #   the Heroku account's API key
+  def initialize(name, opts = {})
+    @name = name.to_s
+
+    opts = DEFAULTS.merge(opts)
+    fail("no API key given") unless opts[:api_key]
+    fail("min_dynos must be at least 1") unless opts[:min_dynos] >= 1
+    fail("max_dynos must be at least 1") unless opts[:max_dynos] >= 1
+    fail("interval must be at least 10") unless opts[:interval] >= 10
+
+    @http = Excon.new(opts[:url] || "http://#{@name}.herokuapp.com/robots.txt")
+    @api  = Heroku::API.new api_key: opts[:api_key]
+
+    @interval  = opts[:interval].to_i
+    @min_dynos = opts[:min_dynos].to_i
+    @max_dynos = opts[:max_dynos].to_i
+    @wait_low  = opts[:wait_low].to_i
+    @wait_high = opts[:wait_high].to_i
+    @min_frequency  = opts[:min_frequency].to_i
+    @last_scaled_at = Time.at(0)
+  end
+
+  # Scales the app
+  def scale!
+    scale_at = next_scale_attempt
+    if Time.now < scale_at
+      log :debug, "skip scaling, next attempt in #{(scale_at - Time.now).to_i}s"
+      return
+    end
+
+    wait = http.get.headers["X-Heroku-Queue-Wait"]
+    unless wait
+      log :warn, "unable to determine queue wait time"
+      return
+    end
+
+    wait = wait.to_i
+    log :debug, "current queue wait time: #{wait}ms"
+
+    if wait <= wait_low
+      do_scale(-1)
+    elsif wait >= wait_high
+      do_scale(1)
+    end
+  end
+
+  # @param [Symbol] level
+  # @param [String] message
+  def log(level, message)
+    Heroku::Scalr.logger.send(level, "[#{name}] #{message}")
+  end
+
+  protected
+
+    # @return [Time] the next scale attempt
+    def next_scale_attempt
+      last_scaled_at + min_frequency
+    end
+
+    def do_scale(by)
+      info = api.get_app(name)
+      unless info.status == 200
+        log :warn, "error fetching app info, responded with #{info.status}"
+        return
+      end
+
+      current = info.body["dynos"].to_i
+      target  = current + by
+      target  = max_dynos if target > max_dynos
+      target  = min_dynos if target < min_dynos
+
+      if target == current
+        log :debug, "skip scaling, keep #{current} dynos"
+        return
+      end
+
+      log :info, "scaling to #{target} dynos"
+      result = api.put_dynos(name, target)
+      unless result.status == 200
+        log :warn, "error scaling app, responded with #{result.status}"
+        return
+      end
+
+      @last_scaled_at = Time.now
+      target
+    end
+
+  private
+
+    def fail(message)
+      raise ArgumentError, "Invalid options: #{message}"
+    end
+
+end

data/lib/heroku/scalr/cli.rb

@@ -0,0 +1,57 @@
+require 'optparse'
+require 'logger'
+
+module Heroku
+  module Scalr
+    class CLI
+
+      def self.run!(argv = ARGV)
+        new(argv).run!
+      end
+
+      def initialize(argv)
+        super()
+        @config_path = "./config.rb"
+        @options     = { log_level: ::Logger::INFO }
+        parser.parse!(argv)
+
+        unless File.file?(@config_path)
+          puts parser
+          exit
+        end
+      end
+
+      def run!
+        require 'heroku/scalr'
+        Heroku::Scalr.configure(@options)
+        Heroku::Scalr.run!(@config_path)
+      end
+
+      def parser
+        @parser ||= OptionParser.new do |o|
+          o.banner = "Usage: heroku-scalr [options]"
+          o.separator ""
+
+          o.on("-C", "--config PATH", "Configuration file path. Default: ./config.rb") do |path|
+            @config_path = path
+          end
+
+          o.on("-l", "--log PATH", "Custom log file path. Default: STDOUT") do |path|
+            @options.update log_file: path
+          end
+
+          o.on("-v", "--verbose", "Enable verbose logging.") do
+            @options.update log_level: ::Logger::DEBUG
+          end
+
+          o.separator ""
+          o.on_tail("-h", "--help", "Show this message") do
+            puts o
+            exit
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/heroku/scalr/config.rb

@@ -0,0 +1,33 @@
+# Loads a config file and evaluates the stored configuration
+#
+# @example of a config file
+#
+#   defaults email: "me@gmail.com", token: "d728201893d47607ec382", interval: 60
+#   app "lonely-warrior-45", url: "http://cnamed.host/robots.txt"
+#
+class Heroku::Scalr::Config
+
+  attr_reader :apps
+
+  # @param [String] path file path containing a configuration
+  def initialize(path)
+    @defaults = {}
+    @apps     = []
+    instance_eval File.read(path)
+  end
+
+  # @param [Hash] opts updates for defaults
+  # @see Heroku::Scalr::App#initialize for a full set of options
+  def defaults(opts = {})
+    @defaults.update(opts)
+  end
+
+  # @param [String] name the Heroku app name
+  # @param [Hash] opts configuration options
+  # @see Heroku::Scalr::App#initialize for a full set of options
+  def app(name, opts = {})
+    opts = @defaults.merge(opts)
+    @apps << Heroku::Scalr::App.new(name, opts)
+  end
+
+end

data/lib/heroku/scalr/runner.rb

@@ -0,0 +1,35 @@
+class Heroku::Scalr::Runner
+  SIGNALS = %w[HUP INT TERM] & Signal.list.keys
+
+  attr_reader :config
+
+  # @param [String] config_path configuration file location
+  def initialize(config_path)
+    @config = Heroku::Scalr::Config.new(config_path)
+  end
+
+  # @return [Timers] recurring timers
+  def timers
+    @timers ||= Timers.new.tap do |t|
+      config.apps.each do |app|
+        app.log :info, "monitoring every #{app.interval}s"
+        t.every(app.interval) { app.scale! }
+      end
+    end
+  end
+
+  # Start the runner
+  def run!
+    SIGNALS.each do |sig|
+      Signal.trap(sig) { stop! }
+    end
+    loop { timers.wait }
+  end
+
+  # Stop execution
+  def stop!
+    Heroku::Scalr.logger.info "Exiting ..."
+    exit(0)
+  end
+
+end

data/lib/heroku/scalr.rb

@@ -0,0 +1,32 @@
+require 'heroku/api'
+require 'logger'
+require 'excon'
+require 'timers'
+
+module Heroku::Scalr
+  extend self
+
+  # @see Heroku::Scalr::Runner#initialize
+  def run!(*args)
+    Heroku::Scalr::Runner.new(*args).run!
+  end
+
+  # @param [Hash] opts
+  # @options opts [String] :log_file custom log file path
+  # @options opts [String] :log_level custom log level
+  def configure(opts = {})
+    @logger = Logger.new(opts[:log_file]) if opts[:log_file]
+    logger.level = opts[:log_level] if opts[:log_level]
+    self
+  end
+
+  # @return [Logger] the logger instance
+  def logger
+    @logger ||= Logger.new(STDOUT)
+  end
+
+end
+
+%w|config app runner|.each do |name|
+  require "heroku/scalr/#{name}"
+end

data/spec/fixtures/config_a.rb

@@ -0,0 +1,9 @@
+defaults api_key: "API_KEY"
+
+app "app1",
+  max_dynos: 3,
+  interval: 180
+
+app "app2",
+  max_dynos: 4,
+  interval: 120

data/spec/heroku/scalr/app_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+describe Heroku::Scalr::App do
+
+  subject    { described_class.new('name', api_key: 'key') }
+
+  def mock_response(status, body)
+    mock "APIResponse", status: status, headers: {}, body: body
+  end
+
+  its(:name)            { should == 'name' }  
+  its(:http)            { should be_instance_of(Excon::Connection) }
+  its(:api)             { should be_instance_of(Heroku::API) }
+
+  its(:interval)        { should be(30) }
+  its(:min_dynos)       { should be(1) }
+  its(:max_dynos)       { should be(2) }
+  its(:wait_low)        { should be(10) }
+  its(:wait_high)       { should be(100) }
+  its(:min_frequency)   { should be(60) }
+  its(:last_scaled_at)  { should == Time.at(0)}
+
+
+  describe "failures" do
+    it "should raise error when there's no API key" do
+      expect { described_class.new("name") }.to raise_error(ArgumentError)
+    end
+
+    it "should raise error when min_dynos < 1" do
+      expect { described_class.new("name", {:api_key => 'key', :min_dynos => 0}) }.to raise_error(ArgumentError)
+    end
+
+    it "should raise error when max_dynos < 1" do
+      expect { described_class.new("name", {:api_key => 'key', :max_dynos => 0}) }.to raise_error(ArgumentError)
+    end
+
+    it "should raise error when interval < 10" do
+      expect { described_class.new("name", {:api_key => 'key', :interval => 9}) }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe "scale!" do
+
+    context "when low wait time" do
+      before do
+        subject.api.stub get_app: mock_response(200, { "dynos" => 2 }), put_dynos: mock_response(200, "")
+      end
+
+      let! :app_request do
+        stub_request(:get, "http://name.herokuapp.com/robots.txt").        
+          to_return(body: "", headers: { "X-Heroku-Queue-Wait" => 3 })
+      end
+
+      it "should skip if scaled too recently" do
+        subject.instance_variable_set :@last_scaled_at, Time.now
+        subject.scale!.should be_nil
+      end
+
+      it "should query the queue wait time from the app" do
+        subject.scale!.should == 1
+        app_request.should have_been_made
+      end
+      
+      it "should check current number of dynos" do
+        subject.api.should_receive(:get_app).with("name").and_return mock_response(200, { "dynos" => 2 })
+        subject.scale!.should == 1
+      end
+
+      it "should update dynos" do
+        subject.api.should_receive(:put_dynos).with("name", 1).and_return mock_response(200, "")
+        subject.scale!.should == 1
+      end
+
+      it "should not scale down if min number of dynos is reached" do
+        subject.api.should_receive(:get_app).with("name").and_return mock_response(200, { "dynos" => 1 })
+        subject.api.should_not_receive(:put_dynos)
+        subject.scale!.should be_nil
+      end
+    end
+
+    context "when high wait time" do
+      before do
+        subject.api.stub get_app: mock_response(200, { "dynos" => 1 }), put_dynos: mock_response(200, "")
+      end
+
+      let! :app_request do
+        stub_request(:get, "http://name.herokuapp.com/robots.txt").        
+          to_return(body: "", headers: { "X-Heroku-Queue-Wait" => 101 })
+      end
+
+      it "should update dynos" do
+        subject.api.should_receive(:get_app).with("name").and_return mock_response(200, { "dynos" => 1 })
+        subject.scale!.should == 2
+      end
+
+      it "should not scale up if max number of dynos is reached" do
+        subject.api.should_receive(:get_app).with("name").and_return mock_response(200, { "dynos" => 2 })
+        subject.api.should_not_receive(:put_dynos)
+        subject.scale!.should be_nil
+      end
+    end
+  end
+
+end

data/spec/heroku/scalr/config_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Heroku::Scalr::Config do
+
+  subject { described_class.new(fixture_path("config_a.rb")) }
+
+  its(:apps)     { should be_instance_of(Array) }
+  its(:apps)     { should have(2).items }
+  its(:defaults) { should eq(api_key: "API_KEY") }
+
+  it 'should merge defaults into app configurations' do
+    app = subject.apps.first
+    app.should be_instance_of(Heroku::Scalr::App)
+    app.api.instance_variable_get(:@api_key).should == "API_KEY"
+  end
+
+end

data/spec/heroku/scalr/runner_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Heroku::Scalr::Runner do
+
+  subject do
+    described_class.new fixture_path("config_a.rb")
+  end
+
+  its(:config) { should be_instance_of(Heroku::Scalr::Config) }
+  its(:timers) { should be_instance_of(Timers) }
+  its(:timers) { should have(2).items }
+
+end

data/spec/heroku/scalr_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Heroku::Scalr do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'bundler/setup'
+require 'rspec'
+require 'webmock/rspec'
+require 'heroku/scalr'
+
+WebMock.disable_net_connect!
+
+module Heroku::Scalr::SpecHelper
+
+  def fixture_path(name)
+    File.join File.expand_path("../fixtures", __FILE__), name
+  end
+
+end
+
+RSpec.configure do |c|
+  c.before { Heroku::Scalr.logger.stub(:add) }
+  c.include Heroku::Scalr::SpecHelper
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: heroku-scalr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Black Square Media
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: timers
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: heroku-api
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.8
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Issues recurring 'pings' to your Heroku apps and scales dynos up or down
+  depending on pre-defined rules
+email: info@blacksquaremedia.com
+executables:
+- heroku-scalr
+extensions: []
+extra_rdoc_files: []
+files:
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- bin/heroku-scalr
+- heroku-scalr.gemspec
+- lib/heroku/scalr.rb
+- lib/heroku/scalr/app.rb
+- lib/heroku/scalr/cli.rb
+- lib/heroku/scalr/config.rb
+- lib/heroku/scalr/runner.rb
+- spec/fixtures/config_a.rb
+- spec/heroku/scalr/app_spec.rb
+- spec/heroku/scalr/config_spec.rb
+- spec/heroku/scalr/runner_spec.rb
+- spec/heroku/scalr_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bsm/heroku-scalr
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.0
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Watch and scale your dynos!
+test_files: []
+has_rdoc: