save-your-dosh 1.0.0

data/Gemfile

@@ -0,0 +1,2 @@
+gem 'heroku-api'
+gem 'json'

data/Gemfile.lock

@@ -0,0 +1,13 @@
+GEM
+  specs:
+    excon (0.16.10)
+    heroku-api (0.3.7)
+      excon (~> 0.16.10)
+    json (1.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  heroku-api
+  json

data/README.md

@@ -0,0 +1,59 @@
+# Save Your Dosh
+
+This is a little gem for [heroku](http://heroku.com) that automatically scales
+dynos in your heroku based app.
+
+## Prerequisites
+
+You obviously have to be on `heroku` and `rails`. You also need the New Relic RPM add-on
+switched on. It doesn't matter whether you have a free or a pro account on new relic.
+
+## Installation
+
+Hook it up as a rubygem in your `Gemfile`
+
+```ruby
+gem 'save-your-dosh'
+```
+
+Make sure you have the following `ENV` vars in your heroku config
+
+```
+» heroku config
+=== doshmosh Config Vars
+.....
+HEROKU_API_KEY:             your-heroku-api-key
+NEW_RELIC_API_KEY:          your-new-relic-api-key
+NEW_RELIC_APP_NAME:         your-app-name-on-new-relic
+NEW_RELIC_ID:               your-account-id-on-new-relic
+......
+```
+
+Once you've done with those, add the `rake save:your:dosh` task in heroku's scheduler
+and set the minimal timeout of `10 mins`. (don't make it less than 6 mins, otherwise
+new relic will kick your ass)
+
+## Configuration
+
+You can mangle with the settings by creating a file like that in your rails app `config/save-your-dosh.yaml`
+
+```yml
+dynos:
+  min: 1
+  max: 5
+  threshold: 50 # % of system busyness when we kick in/out a dyno
+```
+
+
+## How It Works
+
+It's pretty simple, every time you kick the `rake save:your:dosh` task via cron or scheduler,
+it will make a request to the new relic servers for the data on your application business. If
+it goes over the threshold, it will increase the amount of dynos until reaches the max number
+from the config. Otherwise it will try to switch dynos off until reaches the minimal amount.
+
+
+## License
+
+All the code in this package released under the terms of the MIT license
+Copyright (C) 2012 Nikolay Nemshilov

data/init.rb

@@ -0,0 +1 @@
+require 'save_your_dosh'

data/lib/save-your-dosh.rb

@@ -0,0 +1,4 @@
+#
+# Just a dummy for `gem 'save-your-dosh'`
+#
+require File.join(File.dirname(__FILE__),'save_your_dosh.rb')

data/lib/save_your_dosh.rb

@@ -0,0 +1,28 @@
+#
+# The namespace
+#
+module SaveYourDosh
+  extend self
+
+  VERSION = '0.0.0'
+
+  autoload :Config,   'save_your_dosh/config.rb'
+  autoload :Mangler,  'save_your_dosh/mangler.rb'
+  autoload :NewRelic, 'save_your_dosh/new_relic.rb'
+
+
+  def config
+    @config ||= Config.new
+  end
+
+  def mangle!
+    mangler ||= Mangler.new
+    mangler.mangle_dynos!
+    mangler.mangle_workers!
+  end
+
+  Dir[File.join(File.dirname(__FILE__),'tasks/*.rake')].each { |ext|
+    load ext
+  } if defined?(Rake)
+
+end

data/lib/save_your_dosh.yml

@@ -0,0 +1,13 @@
+interval: 5 # minutes
+
+dynos:
+  min:  1
+  max:  5
+  threshold: 50 # % of system busyness when we kick in/out a dyno
+
+workers:
+  min:  0
+  max:  5
+  jobs: 20 # jobs per a worker
+
+notify: some@email.com

data/lib/save_your_dosh/config.rb

@@ -0,0 +1,36 @@
+#
+# The config object
+#
+require 'yaml'
+
+class SaveYourDosh::Config
+  DEFAULTS = File.dirname(__FILE__) + "/../save_your_dosh.yml"
+  KEYS     = %w{ new_relic heroku dynos workers notify interval }
+
+  KEYS.each{ |key| attr_accessor key }
+
+  def initialize
+    @new_relic = {
+      'acc_id'  => ENV['NEW_RELIC_ID'],
+      'app_id'  => ENV['NEW_RELIC_APP_NAME'],
+      'api_key' => ENV['NEW_RELIC_API_KEY']
+    }
+
+    @heroku = {
+      'app_id'   => ENV['APP_NAME'],
+      'api_key'  => ENV['HEROKU_API_KEY']
+    }
+
+    read DEFAULTS
+  end
+
+  def read(file)
+    config = YAML.load_file(file)
+
+    KEYS.each do |key|
+      instance_variable_set "@#{key}", config[key] if config.has_key?(key)
+    end
+  end
+
+end
+

data/lib/save_your_dosh/mangler.rb

@@ -0,0 +1,47 @@
+#
+# Mangles with the actual heroku settings
+#
+require 'heroku-api'
+
+class SaveYourDosh::Mangler
+
+  def initialize
+    @config = SaveYourDosh.config
+    @heroku = Heroku::API.new(api_key: @config.heroku['api_key'])
+  end
+
+  def mangle_dynos!
+    mangle! :dynos do |qty|
+      load = SaveYourDosh::NewRelic.get_dynos_load
+      qty  + (load > @config.dynos['threshold'] ? 1 : -1)
+    end
+  end
+
+  def mangle_workers!
+    mangle! :workers do |qty|
+      qty
+    end
+  end
+
+private
+
+  # a little wrapper to avoid problems with setting/getting
+  # a wrong thing
+  def mangle!(what, &block)
+    qty     = @heroku.get_app(@config.heroku['app_id']).body[what.to_s]
+    new_qty = yield(qty)
+
+    min_qty = @config.send(what)['min']
+    max_qty = @config.send(what)['max']
+
+    new_qty = min_qty if new_qty < min_qty
+    new_qty = max_qty if new_qty > max_qty
+
+    if new_qty != qty
+      Rails.logger.info "SaveYourDosh: mangling with the #{what}, #{qty} -> #{new_qty}" if defined? Rails
+
+      @heroku.send("put_#{what}", @config.heroku['app_id'], new_qty)
+    end
+  end
+
+end

data/lib/save_your_dosh/new_relic.rb

@@ -0,0 +1,36 @@
+#
+# A little proxy for the new-relic API
+#
+require 'json'
+
+class SaveYourDosh::NewRelic
+
+  DYNOS_LOAD_CMD = %Q{
+    curl --silent -H "x-api-key: %{api_key}" \
+      -d "metrics[]=Instance/Busy" \
+      -d "field=busy_percent" \
+      -d "begin=%{begin_time}" \
+      -d "end=%{end_time}" \
+      -d "summary=1" \
+      -d "app=%{app_id}" \
+      https://api.newrelic.com/api/v1/accounts/%{acc_id}/metrics/data.json
+  }.strip
+
+  def self.get_dynos_load
+    conf = SaveYourDosh.config
+
+    data = DYNOS_LOAD_CMD % {
+      app_id:     conf.new_relic['app_id'],
+      acc_id:     conf.new_relic['acc_id'],
+      api_key:    conf.new_relic['api_key'],
+      begin_time: Time.now - conf.interval * 60,
+      end_time:   Time.now
+    }
+
+    JSON.parse(`#{data}`)[0]["busy_percent"]
+
+  rescue JSON::ParserError, NoMethodError
+    return nil
+  end
+
+end

data/lib/tasks/save_your_dosh.rake

@@ -0,0 +1,9 @@
+
+namespace :save do
+  namespace :your do
+    desc "Runs the SaveYourDosh.mangle!"
+    task :dosh do
+      SaveYourDosh.mangle!
+    end
+  end
+end

data/spec/lib/save_your_dosh/config_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe SaveYourDosh::Config do
+  describe "defaults" do
+    before do
+      ENV['NEW_RELIC_ID']       = 'acc-id'
+      ENV['NEW_RELIC_APP_NAME'] = '12345'
+      ENV['NEW_RELIC_API_KEY']  = 'api-key'
+
+      ENV['APP_NAME']           = 'app-name'
+      ENV['HEROKU_API_KEY']     = 'heroku-api-key'
+
+      @config = SaveYourDosh::Config.new
+    end
+
+    it "should have default dynos data" do
+      @config.dynos.should == {
+        "min" => 1, "max" => 5, "threshold" => 50
+      }
+    end
+
+    it "should have default workders data" do
+      @config.workers.should == {
+        "min" => 0, "max" => 5, "jobs" => 20
+      }
+    end
+
+    it "should read the new_relic settings from the ENV hash" do
+      @config.new_relic.should == {
+        'acc_id'  => ENV['NEW_RELIC_ID'],
+        'app_id'  => ENV['NEW_RELIC_APP_NAME'],
+        'api_key' => ENV['NEW_RELIC_API_KEY']
+      }
+    end
+
+    it "should assign the heroku credentials from the ENV data" do
+      @config.heroku.should == {
+        'app_id'   => ENV['APP_NAME'],
+        'api_key'  => ENV['HEROKU_API_KEY']
+      }
+    end
+  end
+end

data/spec/lib/save_your_dosh/mangler_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe SaveYourDosh::Mangler do
+  before do
+    @config  = SaveYourDosh.config
+    @config.heroku = {
+      'app_id'   => 'my-app',
+      'login'    => 'login',
+      'password' => 'my-password'
+    }
+
+    @heroku  = Heroku::API.new(api_key: 'boo hoo')
+
+    Heroku::API.should_receive(:new).
+      with(api_key: @config.heroku['api_key']).
+      and_return(@heroku)
+
+    @mangler = SaveYourDosh::Mangler.new
+  end
+
+  describe ".mangle_dynos!" do
+    before do
+      @heroku.should_receive(:get_app).
+        with(@config.heroku['app_id']).
+        and_return(Struct.new(:body).new({'dynos' => 2, 'workers' => 1}))
+
+      SaveYourDosh::NewRelic.should_receive(:get_dynos_load).
+        and_return(40)
+    end
+
+    it "should try to add dynos if we're getting over the threshold" do
+      @config.dynos['threshold'] = 30
+
+      @heroku.should_receive(:put_dynos).
+        with(@config.heroku['app_id'], 3)
+
+      @mangler.mangle_dynos!
+    end
+
+    it "should try to remove dynos if we're below the threshold" do
+      @config.dynos['threshold'] = 50
+
+      @heroku.should_receive(:put_dynos).
+        with(@config.heroku['app_id'], 1)
+
+      @mangler.mangle_dynos!
+    end
+
+    it "should not go below minimal dynos amount" do
+      @config.dynos['threshold'] = 50
+      @config.dynos['min']       = 2
+      @config.dynos['max']       = 2
+
+      @heroku.should_not_receive(:put_dynos)
+
+      @mangler.mangle_dynos!
+    end
+
+    it "should not go above dynos amount" do
+      @config.dynos['threshold'] = 30
+      @config.dynos['min']       = 1
+      @config.dynos['max']       = 2
+
+      @heroku.should_not_receive(:put_dynos)
+
+      @mangler.mangle_dynos!
+    end
+
+  end
+end

data/spec/lib/save_your_dosh/new_relic_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe SaveYourDosh::NewRelic do
+  before do
+    @config = SaveYourDosh.config
+    @config.new_relic = {
+      'acc_id'  => 'acc-id',
+      'app_id'  => 'app-name',
+      'api_key' => 'api-key'
+    }
+  end
+
+  describe ".get_dynos_load" do
+    it "should make a request to the server for the data" do
+      SaveYourDosh::NewRelic.should_receive(:`).
+
+      with(%Q{
+      curl --silent -H "x-api-key: #{@config.new_relic['api_key']}" \
+      -d "metrics[]=Instance/Busy" \
+      -d "field=busy_percent" \
+      -d "begin=#{Time.now - @config.interval * 60}" \
+      -d "end=#{Time.now}" \
+      -d "summary=1" \
+      -d "app=#{@config.new_relic['app_id']}" \
+      https://api.newrelic.com/api/v1/accounts/#{@config.new_relic['acc_id']}/metrics/data.json
+      }.strip).
+
+      and_return %Q{
+        [{"name":"Instance/Busy","app":"doshmosh","agent_id":513715,"busy_percent":2.299166620165731}]
+      }
+
+      SaveYourDosh::NewRelic.get_dynos_load.should == 2.299166620165731
+    end
+
+    it "should return nil if the server returns not JSON" do
+      SaveYourDosh::NewRelic.should_receive(:`).
+        and_return("Fuck you buddy")
+
+      SaveYourDosh::NewRelic.get_dynos_load.should == nil
+    end
+
+    it "should return nil if the server returns wrong JSON" do
+      SaveYourDosh::NewRelic.should_receive(:`).
+        and_return('{"fuck": "you buddy"}')
+
+      SaveYourDosh::NewRelic.get_dynos_load.should == nil
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'rspec'
+require 'heroku-api'
+
+require File.dirname(__FILE__) + "/../lib/save_your_dosh.rb"
+
+# mocking the Kernel::` calls in the new-relic API proxy
+class SaveYourDosh::NewRelic
+  def self.`(str)
+    ''
+  end
+end
+
+# disabling the Horoku::Client real interactions
+class Heroku::API
+  def initialize(*args)
+  end
+
+  def get_app(name)
+    Struct.new(:body).new({'dynos' => 1, 'workers' => 1})
+  end
+
+  def put_dynos(name, qty)
+  end
+
+  def put_workers(name, qty)
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: save-your-dosh
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Nikolay Nemshilov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-20 00:00:00.000000000 Z
+dependencies: []
+description: This gem can automatically scale the dynos amount on your heroku app
+  depending on your system busyness
+email: nemshilov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/save-your-dosh.rb
+- lib/save_your_dosh/config.rb
+- lib/save_your_dosh/mangler.rb
+- lib/save_your_dosh/new_relic.rb
+- lib/save_your_dosh.rb
+- lib/save_your_dosh.yml
+- lib/tasks/save_your_dosh.rake
+- spec/lib/save_your_dosh/config_spec.rb
+- spec/lib/save_your_dosh/mangler_spec.rb
+- spec/lib/save_your_dosh/new_relic_spec.rb
+- spec/spec_helper.rb
+- README.md
+- init.rb
+- Gemfile
+- Gemfile.lock
+homepage: http://github.com/MadRabbit/save-your-dosh
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Heroku dynos auto-scaling thing
+test_files: []