heroku-qc-autoscale 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm_gemset_create_on_use_flag=1
+rvm use 1.9.2@qc-autoscale

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in heroku-qc-autoscale.gemspec
+gemspec

data/README.md

@@ -0,0 +1,37 @@
+Autoscale QueueClassic workers on Heroku
+==================
+
+Add to a Rails 3.x project to auto scale QueueClassic workers on heroku.
+
+
+Usage
+-----
+
+Install as gem
+    
+    gem install heroku-qc-autoscale
+
+Add to Gemfile
+
+    gem "heroku-qc-autoscale"
+
+
+Create config/initializers/qc_autoscale.rb
+
+    Heroku::QC::Autoscale.config do |c|
+      c.api_key = ENV['HEROKU_API_KEY']
+      c.app     = ENV['HEROKU_APP']
+      c.scale   = [1, 15, 30, 40, 50]
+      c.active  = Rails.env.production?
+    end
+
+Queue jobs as normal with QueueClassic. Based on your scale table, it will recalculate the 
+workers required after each QC#enqueue, and QC#delete.
+
+    QC.enqueue("Time.now")
+
+
+Meta
+----
+
+Released under the [MIT license](http://www.opensource.org/licenses/mit-license.php).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList[File.expand_path('../test/**/*_test.rb', __FILE__)]
+  t.verbose = true
+end

data/heroku-qc-autoscale.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "heroku-qc-autoscale/version"
+
+Gem::Specification.new do |s|
+  s.name        = "heroku-qc-autoscale"
+  s.version     = Heroku::QC::Autoscale::VERSION
+  s.authors     = ["David Bradford"]
+  s.email       = ["david@zerobearing.com"]
+  s.homepage    = ""
+  s.summary     = %q{Auto scale your QueueClassic workers on Heroku. Inspired by mirthlab's Resque auto scale gem.}
+  s.description = %q{Add to a Rails 3.x project to auto scale QueueClassic workers on heroku.}
+
+  s.rubyforge_project = "heroku-qc-autoscale"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_runtime_dependency "heroku-api",      "~> 0.3.2"
+  s.add_runtime_dependency "activesupport",   "~> 3.1.7"
+  s.add_runtime_dependency "i18n",            "~> 0.6.0"
+  s.add_runtime_dependency "queue_classic",   "~> 2.0.1"
+
+  s.add_development_dependency "minitest", "~> 3.3.0"
+  s.add_development_dependency "pry"
+end

data/lib/heroku/scaler.rb

@@ -0,0 +1,49 @@
+module Heroku
+  class Scaler
+    
+    class << self
+      def workers
+        client.get_app(app).body.fetch("workers", 0).to_i
+      end
+
+      def workers=(qty)
+        client.put_workers(app, qty) 
+      end
+
+      def job_count
+        ::QC::Queries.count.to_i
+      end
+
+      # scale workers based on scale
+      def up
+        self.workers = calculate_required_workers unless calculate_required_workers <= workers
+      end
+
+      # shutdown if no jobs exist
+      def down
+        self.workers = 0 if job_count < 1
+      end
+
+      def calculate_required_workers
+        scale.rindex{|x| x <= job_count} + 1
+      end
+
+      # the app to scale
+      def app
+        ::Heroku::QC::Autoscale.app
+      end
+
+      # the scale
+      def scale
+        ::Heroku::QC::Autoscale.scale || [1, 15, 30, 40, 50]
+      end
+
+      # heroku api client
+      def client
+        @@client ||= ::Heroku::API.new( ::Heroku::QC::Autoscale.heroku_params )
+      end
+    end
+
+  end
+  
+end

data/lib/heroku-qc-autoscale/version.rb

@@ -0,0 +1,7 @@
+module Heroku
+  module QC
+    module Autoscale
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/heroku-qc-autoscale.rb

@@ -0,0 +1,35 @@
+require 'active_support/concern'
+require 'active_support/callbacks'
+require 'active_support/core_ext/module'
+require 'queue_classic'
+require 'heroku-api'
+
+require "heroku-qc-autoscale/version"
+
+require "qc/callbacks"
+require "qc/auto_scale"
+require "heroku/scaler"
+
+module Heroku
+  module QC
+    module Autoscale
+      mattr_accessor :api_key, :app, :mock, :scale, :active
+
+      def self.config(&block)
+        yield(self)
+        activate if active == true
+      end
+
+      def self.activate
+        ::QC::Queue.send(:include, ::QC::QueueCallbacks)
+      end
+
+      def self.heroku_params
+        {
+          api_key: self.api_key  || ENV['HEROKU_API_KEY'],
+          mock:    self.mock     || false
+        }
+      end
+    end
+  end
+end

data/lib/qc/auto_scale.rb

@@ -0,0 +1,13 @@
+module QC
+  class AutoScale
+
+    def after_enqueue(caller)
+      Heroku::Scaler.up
+    end
+
+    def after_delete(caller)
+      Heroku::Scaler.down
+    end
+
+  end
+end

data/lib/qc/callbacks.rb

@@ -0,0 +1,28 @@
+module QC
+  module QueueCallbacks
+    extend ActiveSupport::Concern
+
+    included do
+      include ActiveSupport::Callbacks
+      define_callbacks :enqueue, :delete, :scope => [:kind, :name]
+      set_callback :enqueue, :after, QC::AutoScale.new
+      set_callback :delete, :after, QC::AutoScale.new
+      
+      alias_method_chain :enqueue, :callbacks
+      alias_method_chain :delete, :callbacks
+    end
+
+    def enqueue_with_callbacks(method, *args)
+      run_callbacks :enqueue do
+        enqueue_without_callbacks(method, *args)
+      end
+    end
+
+    def delete_with_callbacks(id)
+      run_callbacks :delete do
+        delete_without_callbacks(id)
+      end
+    end
+  end
+end
+

data/test/autoscale_test.rb

@@ -0,0 +1,23 @@
+require_relative "./test_helper"
+
+describe Heroku::QC::Autoscale do
+  
+  before do
+    Heroku::QC::Autoscale.config do |c|
+      c.api_key = "123456"
+    end
+  end
+  
+  subject { Heroku::QC::Autoscale }
+
+  it "should have api_key" do
+    subject.api_key.must_equal("123456")
+  end
+
+  it "should change api_key at runtime" do
+    subject.api_key.must_equal("123456")
+    subject.api_key = "654321"    
+    subject.api_key.must_equal("654321")
+  end
+
+end

data/test/heroku/scaler_test.rb

@@ -0,0 +1,71 @@
+require_relative "../test_helper"
+
+describe Heroku::Scaler do
+  include QCHelper
+
+  QC.define_singleton_method :log do |*args| nil; end # silence QC logger
+
+  subject { Heroku::Scaler }
+
+  it "job_count should be 0" do
+    subject.job_count.must_equal(0)
+  end
+
+  it "#workers" do
+    with_app do |app|
+      subject.workers = 1
+      subject.workers.must_equal(1)
+
+      subject.workers = 2
+      subject.workers.must_equal(2)
+    end
+  end
+
+  describe "scaling up" do
+    it "with 5 jobs" do
+      with_app do |app|
+        5.times{ QC.enqueue("Time.now") }
+        subject.workers.must_equal(1)
+      end
+    end
+
+    it "with 16 jobs" do
+      with_app do |app|
+        16.times{ QC.enqueue("Time.now") }
+        subject.workers.must_equal(2)
+      end
+    end
+
+    it "with 31 jobs" do
+      with_app do |app|
+        31.times{ QC.enqueue("Time.now") }
+        subject.workers.must_equal(3)
+      end
+    end
+
+    it "with 131 jobs" do
+      with_app do |app|
+        131.times{ QC.enqueue("Time.now") }
+        subject.workers.must_equal(5)
+      end
+    end
+  end
+
+  describe "scaling down" do
+
+    it "from 31 workers" do
+      with_app do |app|
+        # add jobs to queue
+        31.times{ QC.enqueue("Time.now") }
+        subject.workers.must_equal(3)
+        
+        # do work and scale back down
+        31.times{ QC::Worker.new.work }
+        subject.job_count.must_equal(0)
+        subject.workers.must_equal(0)
+      end
+    end
+
+  end
+
+end

data/test/qc/queue_test.rb

@@ -0,0 +1,13 @@
+require_relative "../test_helper"
+
+describe QC::Queue do
+  subject { QC::Queue.new("default-test") }
+
+  it "should respond to #enqueue_with_callbacks" do
+    subject.must_respond_to(:enqueue_with_callbacks)
+  end
+
+  it "should respond to #delete_with_callbacks" do
+    subject.must_respond_to(:delete_with_callbacks)
+  end
+end

data/test/support/qc_helper.rb

@@ -0,0 +1,18 @@
+module QCHelper
+
+  def setup
+    init_db
+  end
+
+  def teardown
+    QC.delete_all
+  end
+
+  def init_db(table_name="queue_classic_jobs")
+    QC::Conn.execute("SET client_min_messages TO 'warning'")
+    QC::Setup.drop
+    QC::Setup.create
+    QC::Conn.disconnect
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,39 @@
+# test/test_helper.rb
+
+ENV["TEST"] = 'true'
+ENV["DATABASE_URL"] ||= "postgres:///queue_classic_test"
+
+$:.unshift File.expand_path("../../lib")
+require 'rubygems'
+require 'minitest/autorun'
+require 'pry'
+require 'time'
+
+require 'heroku-qc-autoscale'
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
+
+Heroku::QC::Autoscale.config do |c|
+  c.api_key = "123456"
+  c.app     = "racehq-test"
+  c.mock    = true
+  c.scale   = [1, 15, 30, 40, 50]
+  c.active  = true
+end
+
+# borrowed from heroku-api test helper
+def with_app(params={}, &block)
+  params.merge!('name' => Heroku::QC::Autoscale.app) unless params.key?("name")
+  heroku = Heroku::Scaler.client
+  
+  begin
+    data = heroku.post_app(params).body
+    @name = data['name']
+    ready = false
+    until ready
+      ready = heroku.request(:method => :put, :path => "/apps/#{@name}/status").status == 201
+    end
+    yield(data)
+  ensure
+    heroku.delete_app(@name) rescue nil
+  end
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: heroku-qc-autoscale
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Bradford
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: heroku-api
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.7
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: queue_classic
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Add to a Rails 3.x project to auto scale QueueClassic workers on heroku.
+email:
+- david@zerobearing.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.md
+- Rakefile
+- heroku-qc-autoscale.gemspec
+- lib/heroku-qc-autoscale.rb
+- lib/heroku-qc-autoscale/version.rb
+- lib/heroku/scaler.rb
+- lib/qc/auto_scale.rb
+- lib/qc/callbacks.rb
+- test/autoscale_test.rb
+- test/heroku/scaler_test.rb
+- test/qc/queue_test.rb
+- test/support/qc_helper.rb
+- test/test_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3951171285968165463
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3951171285968165463
+requirements: []
+rubyforge_project: heroku-qc-autoscale
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Auto scale your QueueClassic workers on Heroku. Inspired by mirthlab's Resque
+  auto scale gem.
+test_files:
+- test/autoscale_test.rb
+- test/heroku/scaler_test.rb
+- test/qc/queue_test.rb
+- test/support/qc_helper.rb
+- test/test_helper.rb