dyno_scaler 0.1.0

data/.gitignore

@@ -0,0 +1,16 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format documentation
+--debug
+--drb

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3-p0@dyno_scaler --create

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - jruby-19mode # JRuby in 1.9 mode

data/Gemfile

@@ -0,0 +1,20 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dyno_scaler.gemspec
+gemspec
+
+group(:development) do
+  platforms :mri_19 do
+    gem 'debugger'
+  end
+
+  platforms :jruby do
+    gem 'ruby-debug'
+    gem 'jruby-openssl'
+  end
+end
+
+group(:test) do
+  gem 'simplecov', require: false
+  gem 'rails'
+end

data/Gemfile.lock

@@ -0,0 +1,158 @@
+PATH
+  remote: .
+  specs:
+    dyno_scaler (0.1.0)
+      activesupport
+      heroku-api
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.9)
+      actionpack (= 3.2.9)
+      mail (~> 2.4.4)
+    actionpack (3.2.9)
+      activemodel (= 3.2.9)
+      activesupport (= 3.2.9)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.9)
+      activesupport (= 3.2.9)
+      builder (~> 3.0.0)
+    activerecord (3.2.9)
+      activemodel (= 3.2.9)
+      activesupport (= 3.2.9)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.9)
+      activemodel (= 3.2.9)
+      activesupport (= 3.2.9)
+    activesupport (3.2.9)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    bouncy-castle-java (1.5.0146.1)
+    builder (3.0.4)
+    columnize (0.3.6)
+    connection_pool (0.9.3)
+    debugger (1.2.2)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.1.1)
+      debugger-ruby_core_source (~> 1.1.5)
+    debugger-linecache (1.1.2)
+      debugger-ruby_core_source (>= 1.1.1)
+    debugger-ruby_core_source (1.1.5)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    excon (0.16.10)
+    girl_friday (0.11.1)
+      connection_pool (~> 0.9.0)
+      rubinius-actor
+    heroku-api (0.3.7)
+      excon (~> 0.16.10)
+    hike (1.2.1)
+    i18n (0.6.1)
+    journey (1.0.4)
+    jruby-openssl (0.8.2)
+      bouncy-castle-java (>= 1.5.0146.1)
+    json (1.7.5)
+    json (1.7.5-java)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.5.0)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-protection (1.3.2)
+      rack
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.9)
+      actionmailer (= 3.2.9)
+      actionpack (= 3.2.9)
+      activerecord (= 3.2.9)
+      activeresource (= 3.2.9)
+      activesupport (= 3.2.9)
+      bundler (~> 1.0)
+      railties (= 3.2.9)
+    railties (3.2.9)
+      actionpack (= 3.2.9)
+      activesupport (= 3.2.9)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.0.3)
+    rdoc (3.12)
+      json (~> 1.4)
+    redis (3.0.2)
+    redis-namespace (1.2.1)
+      redis (~> 3.0.0)
+    resque (1.23.0)
+      multi_json (~> 1.0)
+      redis-namespace (~> 1.0)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
+    rubinius-actor (0.0.2)
+      rubinius-core-api
+    rubinius-core-api (0.0.1)
+    rubinius-core-api (0.0.1-java)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4-java)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    sinatra (1.3.3)
+      rack (~> 1.3, >= 1.3.6)
+      rack-protection (~> 1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.16.0)
+    tilt (1.3.3)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.35)
+    vegas (0.1.11)
+      rack (>= 1.0.0)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  debugger
+  dyno_scaler!
+  girl_friday
+  jruby-openssl
+  rails
+  resque
+  rspec
+  ruby-debug
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Vicente Mundim
+
+MIT License
+
+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,103 @@
+# DynoScaler
+
+[![alt build status][1]][2]
+
+[1]: https://travis-ci.org/dtmconsultoria/dyno_scaler.png?branch=master
+[2]: http://travis-ci.org/dtmconsultoria/dyno_scaler
+
+Scale your dyno workers on Heroku as needed, pay only for what you use!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dyno_scaler'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dyno_scaler
+
+## Usage
+
+Just include this module in your Resque job and you're good to go:
+
+    class MyJob
+      include DynoScaler::Workers::Resque
+
+      ...
+    end
+
+You can access the configuration with (for example):
+
+    DynoScaler.configuration.max_workers = 3
+
+In Rails, you can access it easily in your application.rb:
+
+    config.dyno_scaler.max_workers = 3
+
+If you want to scale up or down your workers manually, you can use the manager
+directly:
+
+    DynoScaler.manager.scale_up(options)
+    DynoScaler.manager.scale_down(options)
+
+You must pass an options hash with the number of workers, the number of pending
+jobs, and the number of running jobs, like so:
+
+    {
+      workers: 10,
+      working: 3,
+      pending: 5
+    }
+
+`Resque.info` returns a hash with these keys, so you may just pass it instead:
+
+    DynoScaler.manager.scale_up(Resque.info)
+
+You can also use the `DynoScaler::Manager#scale_with` method, passing the `Resque.info`:
+
+    DynoScaler.manager.scale_with(Resque.info)
+
+It will check whether to scale up or down based on the number of workers running,
+pending jobs, and working jobs.
+
+## Heroku Deploy
+
+When deploying to heroku you'll want to add these two configuration keys:
+
+    HEROKU_API_KEY=<YOUR-API-KEY-HERE>
+    HEROKU_APPLICATION=<THE-NAME-OF-YOUR-APP-ON-HEROKU-HERE>
+
+They are used by the [heroku-api](https://github.com/heroku/heroku.rb) gem to
+scale dynos of your application.
+
+## Async
+
+Whenever DynoScaler needs to scale workers up it will perform a request to the
+Heroku API. This request may sometimes take longer to return than one would want.
+Because of this we have a async option that uses
+[GirlFriday](https://github.com/mperham/girl_friday) to handle this call
+asynchronously. To enable it, just set it to `true`:
+
+    config.dyno_scaler.async = true
+
+You can also give it a block to better customize it. It will receive an options
+hash that can be passed to the `DynoScaler::Manager#scale_with` method, like so:
+
+    MY_QUEUE = GirlFriday::WorkQueue.new(:my_queue, size: 5) do |options|
+      DynoScaler.manager.scale_with(options)
+    end
+
+    config.dyno_scaler.async { MY_QUEUE << options }
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/dyno_scaler.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dyno_scaler/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "dyno_scaler"
+  gem.version       = DynoScaler::VERSION
+  gem.authors       = ["Vicente Mundim"]
+  gem.email         = ["vicente.mundim@gmail.com"]
+  gem.description   = %q{Scale your dyno workers on Heroku as needed}
+  gem.summary       = %q{Scale your dyno workers on Heroku as needed}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "heroku-api"
+  gem.add_dependency "activesupport"
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "resque"
+  gem.add_development_dependency "girl_friday"
+end

data/lib/dyno_scaler/configuration.rb

@@ -0,0 +1,110 @@
+# encoding: utf-8
+
+module DynoScaler
+  class Configuration
+    ##
+    # Contains the max amount of workers that are allowed to run concurrently
+    #
+    # @return [Fixnum] default: 1
+    attr_accessor :max_workers
+
+    ##
+    # Contains the min amount of workers that should always be running
+    #
+    # @return [Fixnum] default: 0
+    attr_accessor :min_workers
+
+    ##
+    # Contains the ratio used to spawn more workers given a number of jobs.
+    #
+    # The given hash should have the number of workers as a key, and the number
+    # of queued jobs that are needed in order to spawn that number of workers
+    # as the value.
+    #
+    # For example, if you wanted to spawn a second worker once 6 jobs are queued
+    # then spawn another third worker once 10 jobs are queued you could configure
+    # this option as:
+    #
+    #   config.job_worker_ratio = {
+    #     1 => 1,
+    #     2 => 6,
+    #     3 => 10
+    #   }
+    #
+    # @param [Hash] with job worker ratio
+    # @return [Hash] default to { 1 => 1, 2 => 25, 3 => 50, 4 => 75, 5 => 100 }
+    attr_accessor :job_worker_ratio
+
+    ##
+    # Default is false when HEROKU_API_KEY environment variable is not set,
+    # otherwise defaults to true.
+    #
+    # @param [Boolean] whether to enable scaling or not
+    # @return [Boolean] default: false
+    attr_accessor :enabled
+    alias enabled? enabled
+
+    ##
+    # Default is nil when HEROKU_APP environment variable is not set,
+    # otherwise defaults to its value.
+    #
+    # @param [String] the name of the Heroku application used when scaling workers
+    # @return [String] default: nil
+    attr_accessor :application
+
+    def initialize
+      self.max_workers      = 1
+      self.min_workers      = 0
+      self.enabled          = !ENV['HEROKU_API_KEY'].nil?
+      self.application      = ENV['HEROKU_APP']
+
+      self.job_worker_ratio = {
+        1 => 1,
+        2 => 25,
+        3 => 50,
+        4 => 75,
+        5 => 100
+      }
+    end
+
+    # Returns the current configured async Proc or configures one.
+    def async(&block)
+      @async = block if block_given?
+      @async
+    end
+    alias_method :async?, :async
+
+    ##
+    # When set to true it will use GirlFriday to asynchronous process the scaling,
+    # otherwise you may pass a Proc that will be called whenever scaling is needed.
+    #
+    # Defaults to false, meaning that scaling is processed synchronously.
+    def async=(value)
+      @async = value == true ? default_async_processor : value
+    end
+
+    ##
+    # The logger to be used to log message
+    #
+    # When using Rails it will default to Rails.logger, otherwise it will be
+    # set a `Logger.new(STDERR)`.
+    #
+    # @param [Logger] the logger to be used
+    # @return [Logger] default: nil
+    def logger
+      @logger ||= defined?(Rails) ? Rails.logger || Logger.new(STDERR) : Logger.new(STDERR)
+    end
+    attr_writer :logger
+
+    private
+      def default_async_processor
+        require 'girl_friday'
+
+        queue = GirlFriday::WorkQueue.new(nil, :size => 1) do |options|
+          DynoScaler.manager.scale_with(options)
+        end
+
+        Proc.new { |options| queue << options }
+      end
+  end
+end

data/lib/dyno_scaler/engine.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+module DynoScaler
+  class Engine < ::Rails::Engine
+    config.dyno_scaler = DynoScaler.configuration
+  end
+end

data/lib/dyno_scaler/heroku.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module DynoScaler
+  class Heroku
+    attr_accessor :application
+
+    def initialize(application)
+      self.application = application
+    end
+
+    def scale_workers(quantity)
+      heroku_client.post_ps_scale(application, 'worker', quantity)
+    end
+
+    protected
+      def heroku_client
+        @heroku_client ||= ::Heroku::API.new
+      end
+  end
+end

data/lib/dyno_scaler/manager.rb

@@ -0,0 +1,77 @@
+# encoding: utf-8
+
+module DynoScaler
+  class Manager
+    attr_accessor :options
+
+    def scale_up(options)
+      return unless config.enabled?
+
+      self.options = options
+
+      scale_to(number_of_workers_needed) if scale_up?
+    end
+
+    def scale_up?
+      workers_needed = number_of_workers_needed
+
+      pending_jobs? && workers_needed > options[:workers] && workers_needed <= config.max_workers
+    end
+
+    def scale_down(options)
+      return unless config.enabled?
+
+      self.options = options
+
+      scale_to(config.min_workers) if scale_down?
+    end
+
+    def scale_down?
+      options[:workers] > config.min_workers && !pending_jobs? && !working_jobs?
+    end
+
+    def scale_with(options)
+      return unless config.enabled?
+
+      action = options[:action] || action_for(options)
+      send(action, options) if action
+    end
+
+    protected
+      def config
+        DynoScaler.configuration
+      end
+
+      def scale_to(number_of_workers)
+        config.logger.info "Scaling workers to #{number_of_workers}"
+        heroku.scale_workers(number_of_workers)
+      end
+
+      def pending_jobs?
+        options[:pending] > 0
+      end
+
+      def working_jobs?
+        options[:working] > 0
+      end
+
+      def number_of_workers_needed
+        value = config.job_worker_ratio.reverse_each.find do |_, pending_jobs|
+          options[:pending] >= pending_jobs
+        end
+
+        value ? value.first : 0
+      end
+
+      def action_for(options)
+        self.options = options
+
+        return :scale_down if scale_down?
+        return :scale_up if scale_up?
+      end
+
+      def heroku
+        @heroku ||= DynoScaler::Heroku.new config.application
+      end
+  end
+end

data/lib/dyno_scaler/version.rb

@@ -0,0 +1,3 @@
+module DynoScaler
+  VERSION = "0.1.0"
+end

data/lib/dyno_scaler/workers/resque.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+
+require 'active_support/concern'
+
+module DynoScaler
+  module Workers
+    module Resque
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :scale_up_enabled
+        class_attribute :scale_down_enabled
+
+        enable_scaling_up
+        enable_scaling_down
+      end
+
+      module ClassMethods
+        def after_perform_scale_down(*args)
+          info = ::Resque.info
+          working = info[:working] > 0 ? info[:working] - 1 : 0
+          info.merge!(working: working) # we are not working anymore
+
+          dyno_scaler_manager.scale_down(info) if scale_down_enabled?
+        rescue StandardError => e
+          $stderr.puts "Could not scale down workers: #{e}"
+        end
+
+        def after_enqueue_scale_up(*args)
+          if scale_up_enabled?
+            if DynoScaler.configuration.async?
+              DynoScaler.configuration.async.call(::Resque.info.merge(action: :scale_up))
+            else
+              dyno_scaler_manager.scale_up(::Resque.info)
+            end
+          end
+        rescue StandardError => e
+          $stderr.puts "Could not scale up workers: #{e}"
+        end
+
+        def enable_scaling_up
+          self.scale_up_enabled = true
+        end
+
+        def enable_scaling_down
+          self.scale_down_enabled = true
+        end
+
+        def disable_scaling_up
+          self.scale_up_enabled = false
+        end
+
+        def disable_scaling_down
+          self.scale_down_enabled = false
+        end
+
+        private
+          def dyno_scaler_manager
+            @manager ||= DynoScaler::Manager.new
+          end
+      end
+    end
+  end
+end

data/lib/dyno_scaler/workers.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+module DynoScaler
+  module Workers
+    autoload :Resque, 'dyno_scaler/workers/resque'
+  end
+end

data/lib/dyno_scaler.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+require "dyno_scaler/version"
+require "active_support/core_ext/class/attribute"
+require "heroku-api"
+
+module DynoScaler
+  autoload :Configuration, 'dyno_scaler/configuration'
+  autoload :Heroku,        'dyno_scaler/heroku'
+  autoload :Manager,       'dyno_scaler/manager'
+  autoload :Workers,       'dyno_scaler/workers'
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.manager
+    @manager ||= Manager.new
+  end
+
+  def self.reset!
+    @configuration = nil
+    @manager = nil
+  end
+end
+
+require "dyno_scaler/engine" if defined?(Rails)