heroku-scaler 0.1.11 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d9da01ef9c047bf8ba94ac959180e4c853c7937
-  data.tar.gz: 92b23067c35522391e6401ecdcdedebfbf38b2b9
+  metadata.gz: e8b289781885499b26a6a5d92ddcdff1bdd8e448
+  data.tar.gz: 276acb502af5724c36f861b34aaa46f1a3ee2789
 SHA512:
-  metadata.gz: 829cb9be362a94790490a5f67234eaae5c900ce0ff173e075b5cdaa8cf55883b1d5c535a35bed42746e18340f5537fca07a00b8f4d6e04820352191b2e83b298
-  data.tar.gz: 70cff84b5a1ed2b454a63c9c14844bda245667a4bc9796af54eefe782e74d504b89ab5ccade4fd967d907b7d8d8f9156a713a0b45d7bad73ca051128e1005e0a
+  metadata.gz: 7790e5d9c3f1ace9c7d9b73a8ce9d515c8a740c7d7868875bd4b06f8cb50885662e136483bd29a44b38505dea654648bb21411fe3370f331723dba9927651384
+  data.tar.gz: 8c6b48c9e456ada4d33520c1b3adc32b081bca1be49a79e20019577ba4f2c2407f6c88bd2e35c8255461c76082da4bc6043471cac863f7351caedf8de8f5bff1

data/.gitignore

@@ -27,9 +27,9 @@ build/
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
+Gemfile.lock
+.ruby-version
+.ruby-gemset
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc

data/Gemfile

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

data/README.md

@@ -1 +1,98 @@
-# heroku-scaler
+# Heroku Scaler
+
+The Heroku Scaler gem allows for free scaling of Heroku web dynos.
+It exposes 3 simple rake tasks that can be called from the free [Heroku
+Scheduler](https://elements.heroku.com/addons/scheduler).
+
+This is perfect for applications that see heavy use during known times of the day or week.  For example, we have some customers with business systems that see 99.9% of their traffic during regular business hours on the weekdays.  Since Heroku charges for dynos based on the number of seconds the dynos are running, scaling down application dynos during off-peak times can mean big savings.  Running your larger dyno setup during the 25% of normal business hours can save a bundle!  There are other tools that purport to do this but they often charge money and have, in our experience, been poorly supported.
+
+## Commands
+
+The Heroku Scaler gem exposes three rake commands when added to a Rails application.
+
+The below command will scale your application web dynos to the SCALE_BIG_DYNO_COUNT and SCALE_BIG_DYNO_TYPE.
+
+`rake heroku_scale:web:up`
+
+The below command will scale your application web dynos to the SCALE_SMALL_DYNO_COUNT and SCALE_SMALL_DYNO_TYPE.
+
+`rake heroku_scale:web:down`
+
+The below command will scale your application web dynos to the SCALE_BIG_DYNO_COUNT and SCALE_BIG_DYNO_TYPE if it is a weekday.
+
+`rake heroku_scale:web:up_if_weekday`
+
+## Configuration options
+
+All of these configuration options can be set through the Heroku application configuration (`heroku config:set SOME_SETTING=some_value`)
+
+| Setting | Default | |
+| --- | --- | --- |
+| SCALE_APP_NAME| | your Heroku application name |
+| SCALE_BIG_DYNO_COUNT | 3 | the number of scaled up dynos |
+| SCALE_BIG_DYNO_TYPE | Standard-2X | the type of scaled up dyno |
+| SCALE_OAUTH_TOKEN | | Heroku account auth token |
+| SCALE_SMALL_DYNO_COUNT | 1 | the number of scaled down dynos |
+| SCALE_SMALL_DYNO_TYPE | Standard=1X | the type of scaled down dyno |
+
+## Installation
+
+1. Add Heroku Scaler to your Rails application.
+
+  add the gem to your `Gemfile`
+
+  `gem "heroku_scaler"`
+
+  User Bundler to install the gem in your project
+
+  ```shell
+  bundle
+  ```
+
+2. Generate an
+2. Add settings to your Heroku configuration.
+
+  Assuming a Heroku application named "my-cool-app":
+
+  ```shell
+  heroku config:set SCALE_APP_NAME=my-cool-app
+  heroku config:set SCALE_BIG_DYNO_COUNT=2
+  heroku config:set SCALE_BIG_DYNO_TYPE=Standard-1X
+  heroku config:set SCALE_OAUTH_TOKEN=<some_token_here>
+  heroku config:set SCALE_SMALL_DYNO_COUNT=2
+  heroku config:set SCALE_SMALL_DYNO_TYPE=Standard-2X
+  ```
+3. Install the [Heroku
+Scheduler](https://elements.heroku.com/addons/scheduler) into your Heroku application.
+
+4. Add scheduled events at the times you wish for your application to scale up or down.
+
+## Running tests
+
+```shell
+bundle
+bundle exec rspec spec
+```
+
+## Left to do
+
+1. Add support for time zones so the `heroku_scale:web:up_if_weekday` task behaves as expected in all time zones.
+2. Add support for scaling Heroku workers
+
+## Contributing
+
+Please feel free to submit pull requests or issues. Support for more servers would be neat.
+
+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
+
+## About Foraker Labs
+
+[![Foraker Logo](http://assets.foraker.com/attribution_logo.png)](https://www.foraker.com/)
+
+[Foraker Labs](https://www.foraker.com/) builds exciting web and mobile apps in Boulder, CO. Our work powers a wide variety of businesses with many different needs. We love open source software, and we're proud to contribute where we can. Interested to learn more? [Contact us today](https://www.foraker.com/contact-us).
+
+This project is maintained by Foraker Labs. The names and logos of Foraker Labs are fully owned and copyright Foraker Design, LLC.

data/heroku-scaler.gemspec

@@ -17,4 +17,6 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.add_dependency 'platform-api', '~> 0'
+
+  s.add_development_dependency "rspec", '~> 3'
 end

data/lib/heroku-scaler/config.rb

@@ -0,0 +1,33 @@
+module HerokuScaler
+  class Config
+    attr_reader :settings
+
+    def initialize(settings=ENV)
+      @settings=settings
+    end
+
+    def app_name
+      settings["SCALE_APP_NAME"]
+    end
+
+    def big_dyno_type
+      settings["SCALE_BIG_DYNO_TYPE"] || "Standard-2X"
+    end
+
+    def big_dyno_count
+      settings["SCALE_BIG_DYNO_COUNT"] || 3
+    end
+
+    def small_dyno_type
+      settings["SCALE_SMALL_DYNO_TYPE"] || "Standard-1X"
+    end
+
+    def small_dyno_count
+      settings["SCALE_SMALL_DYNO_COUNT"] || 1
+    end
+
+    def auth_token
+      settings["SCALE_OAUTH_TOKEN"]
+    end
+  end
+end

data/lib/heroku-scaler/version.rb

@@ -1,3 +1,3 @@
 module HerokuScaler
-  VERSION = '0.1.11'
+  VERSION = '0.1.13'
 end

data/lib/heroku-scaler/web_scale.rb

@@ -0,0 +1,49 @@
+module HerokuScaler
+  class WebScale
+    extend Forwardable
+
+    def initialize(config=Config.new, platform_api=PlatformAPI)
+      @config = config
+      @platform_api = platform_api
+    end
+
+    def up!
+      web_scale(big_dyno_type, big_dyno_count)
+    end
+
+    def up_if_weekday!
+      up! if weekday?
+    end
+
+    def down!
+      web_scale(small_dyno_type, small_dyno_count)
+    end
+
+    def weekday?
+      (1..5).include?(Date.today.cwday)
+    end
+
+    private
+
+    attr_reader :config, :platform_api
+
+    def_delegators :config,
+      :app_name,
+      :big_dyno_type,
+      :big_dyno_count,
+      :small_dyno_type,
+      :small_dyno_count,
+      :auth_token
+
+    def web_scale(dyno_type, dyno_count)
+      heroku.formation.update(app_name, 'web', {
+        size: dyno_type,
+        quantity: dyno_count
+      })
+    end
+
+    def heroku
+      @heroku ||= platform_api.connect_oauth(auth_token)
+    end
+  end
+end

data/lib/tasks/heroku_scale.rake

@@ -2,55 +2,17 @@ namespace :heroku_scale do
   namespace :web do
     desc "Scale heroku web dynos up if it is a weekday"
     task :up_if_weekday do
-      Rake::Task['heroku_scale:web:up'].invoke if weekday?
+      HerokuScaler::WebScale.new.up_if_weekday!
     end
 
     desc "Scale heroku web dynos up"
     task :up do
-      heroku.formation.update(app_name, 'web', {
-        "size" => big_dyno_type,
-        "quantity" => big_dyno_count
-      })
+      HerokuScaler::WebScale.new.up!
     end
 
     desc "Scale heroku web dynos down"
     task :down do
-      heroku.formation.update(app_name, 'web', {
-        "size" => small_dyno_type,
-        "quantity" => small_dyno_count
-      })
+      HerokuScaler::WebScale.new.down!
     end
   end
 end
-
-def heroku
-  @heroku ||= PlatformAPI.connect_oauth(oauth_token)
-end
-
-def oauth_token
-  ENV["SCALE_OAUTH_TOKEN"]
-end
-
-def app_name
-  ENV["SCALE_APP_NAME"] || 'ids-production'
-end
-
-def big_dyno_type
-  ENV["SCALE_BIG_DYNO_TYPE"] || "Performance"
-end
-
-def big_dyno_count
-  ENV["SCALE_BIG_DYNO_COUNT"] || 3
-end
-
-def small_dyno_type
-  ENV["SCALE_SMALL_DYNO_TYPE"] || "Standard-2X"
-end
-
-def small_dyno_count
-  ENV["SCALE_SMALL_DYNO_COUNT"] || 1
-end
-
-def weekday?
-  (1..5).include?(Date.today.cwday)
-end

data/spec/lib/heroku-scaler/config_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'heroku-scaler/config'
+
+module HerokuScaler
+  describe Config do
+    let(:config) { HerokuScaler::Config.new({}) }
+
+    describe "#big_dyno_type" do
+      it "has a default" do
+        expect(config.big_dyno_type).to eq("Standard-2X")
+      end
+    end
+
+    describe "#big_dyno_count" do
+      it "has a default" do
+        expect(config.big_dyno_count).to eq(3)
+      end
+    end
+
+    describe "#small_dyno_type" do
+      it "has a default" do
+        expect(config.small_dyno_type).to eq("Standard-1X")
+      end
+    end
+
+    describe "#small_dyno_count" do
+      it "has a default" do
+        expect(config.small_dyno_count).to eq(1)
+      end
+    end
+  end
+end

data/spec/lib/heroku-scaler/web_scale_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+require 'heroku-scaler/web_scale'
+
+module HerokuScaler
+  class TestConfig
+    def app_name
+      "bonanza"
+    end
+
+    def big_dyno_type
+      "big-boy"
+    end
+
+    def big_dyno_count
+      99
+    end
+
+    def small_dyno_type
+      "small-boy"
+    end
+
+    def small_dyno_count
+      9
+    end
+
+    def auth_token
+      "some-token"
+    end
+  end
+
+  class TestPlatformAPI
+    def self.connect_oauth(token)
+      TestHeroku.new
+    end
+  end
+
+  class TestHeroku
+    def formation
+      TestFormation.new
+    end
+  end
+
+  class TestFormation
+    def update(app, type, hash)
+    end
+  end
+
+  describe WebScale do
+    let(:platform_api) { TestPlatformAPI }
+    let(:scaler) { HerokuScaler::WebScale.new(TestConfig.new, platform_api) }
+
+    describe "#up!" do
+      it "calls update" do
+        expect_any_instance_of(TestFormation).to receive(:update).with(
+          "bonanza",
+          "web",
+          {
+            size: "big-boy",
+            quantity: 99
+          }
+        )
+        scaler.up!
+      end
+    end
+
+    describe "#down!" do
+      it "calls update" do
+        expect_any_instance_of(TestFormation).to receive(:update).with(
+          "bonanza",
+          "web",
+          {
+            size: "small-boy",
+            quantity: 9
+          }
+        )
+        scaler.down!
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'heroku-scaler'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heroku-scaler
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.13
 platform: ruby
 authors:
 - stirlingolson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-12 00:00:00.000000000 Z
+date: 2015-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: platform-api
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 description: A simple script to allow cron-based scaling of a Heroku app
 email: seo@foraker.com
 executables: []
@@ -31,13 +45,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- Gemfile
 - LICENSE
 - README.md
 - heroku-scaler.gemspec
 - lib/heroku-scaler.rb
+- lib/heroku-scaler/config.rb
 - lib/heroku-scaler/railtie.rb
 - lib/heroku-scaler/version.rb
+- lib/heroku-scaler/web_scale.rb
 - lib/tasks/heroku_scale.rake
+- spec/lib/heroku-scaler/config_spec.rb
+- spec/lib/heroku-scaler/web_scale_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/foraker/heroku-scaler
 licenses:
 - MIT
@@ -58,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Heroku Scaler