heroku-resque-workers-scaler 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c961a70660acefe4fe1942406fee5acb418be592
-  data.tar.gz: 3f4947d5a7ab4c012dd790c5f8501c8bf9f5eb71
+  metadata.gz: 13c53ba1d25943cf147a88cad016bd1f27533322
+  data.tar.gz: 1614140657d92c11e5a0fc4b65fb3d2c27013cfd
 SHA512:
-  metadata.gz: 91c78eae89d912338dc20d291ef9f447a5b341382ce8af3bd954d396fbe6d9c723432a4816595c7f636acc90bb18f703587959e82be1b4d35874216ed4f7ca75
-  data.tar.gz: cd580a824145cf8a6d0da0f11fdda4836c832c87c8d470f5d59c65a915f13e8fc5bfd2caa0189be63fdd8d5e2b1a0b7d908ee32ef5f9f8d5e369cf92c4739827
+  metadata.gz: 2d710e9001c4caa3e3837433339a6660a9a1c2e285768701d40f655d8eb160a68a8f09edbce58f816adf1f38ccae4579f8ca5945c7d37e8feef823337a236100
+  data.tar.gz: e801d73f45408acfb158e5a7ff4871a73338881d70a28e06aed35c436cff72ef4c0601bf2d45cfa4679067cf331d6044f23c0692ee100a0cb8d8958316eb3321

data/.rvmrc

@@ -1 +1 @@
-rvm use ruby-1.9.3-p194@scaler --create
+rvm use ruby-2.1.1@scaler --create

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# Changelog  VERSION = '0.2.0'
+
+[Fullcahnges](https://github.com/joel/heroku-resque-workers-scaler/pull/6)
+
 # Changelog  VERSION = '0.1.9'
 
 [Fullcahnges](https://github.com/joel/heroku-resque-workers-scaler/pull/5)

data/Gemfile.lock

@@ -1,88 +1,90 @@
 PATH
   remote: .
   specs:
-    heroku-resque-workers-scaler (0.1.6)
-      heroku-api
+    heroku-resque-workers-scaler (0.1.9)
+      platform-api
       resque
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (3.2.8)
-      actionpack (= 3.2.8)
-      mail (~> 2.4.4)
-    actionpack (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
-      builder (~> 3.0.0)
+    actionmailer (4.1.1)
+      actionpack (= 4.1.1)
+      actionview (= 4.1.1)
+      mail (~> 2.5.4)
+    actionpack (4.1.1)
+      actionview (= 4.1.1)
+      activesupport (= 4.1.1)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.1)
+      activesupport (= 4.1.1)
+      builder (~> 3.1)
       erubis (~> 2.7.0)
-      journey (~> 1.0.4)
-      rack (~> 1.4.0)
-      rack-cache (~> 1.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.1.3)
-    activemodel (3.2.8)
-      activesupport (= 3.2.8)
-      builder (~> 3.0.0)
-    activerecord (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activeresource (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
-    activesupport (3.2.8)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    addressable (2.3.2)
-    arel (3.0.2)
-    builder (3.0.4)
-    crack (0.3.1)
-    diff-lcs (1.1.3)
+    activemodel (4.1.1)
+      activesupport (= 4.1.1)
+      builder (~> 3.1)
+    activerecord (4.1.1)
+      activemodel (= 4.1.1)
+      activesupport (= 4.1.1)
+      arel (~> 5.0.0)
+    activesupport (4.1.1)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    addressable (2.3.6)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
     erubis (2.7.0)
-    excon (0.25.3)
-    heroku-api (0.3.15)
-      excon (~> 0.25.1)
-    hike (1.2.1)
-    i18n (0.6.1)
-    journey (1.0.4)
-    json (1.7.5)
-    mail (2.4.4)
-      i18n (>= 0.4.0)
+    excon (0.39.5)
+    heroics (0.0.12)
+      erubis (~> 2.7.0)
+      excon
+      moneta
+      multi_json (>= 1.9.2)
+      netrc
+    hike (1.2.3)
+    i18n (0.6.9)
+    json (1.8.1)
+    mail (2.5.4)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.19)
+    mime-types (1.25.1)
+    minitest (5.3.4)
+    moneta (0.8.0)
     mono_logger (1.1.0)
-    multi_json (1.3.6)
-    polyglot (0.3.3)
-    rack (1.4.1)
-    rack-cache (1.2)
-      rack (>= 0.4)
+    multi_json (1.10.0)
+    netrc (0.7.7)
+    platform-api (0.2.0)
+      heroics (~> 0.0.10)
+    polyglot (0.3.4)
+    psych (2.0.5)
+    rack (1.5.2)
     rack-protection (1.5.3)
       rack
-    rack-ssl (1.3.2)
-      rack
     rack-test (0.6.2)
       rack (>= 1.0)
-    rails (3.2.8)
-      actionmailer (= 3.2.8)
-      actionpack (= 3.2.8)
-      activerecord (= 3.2.8)
-      activeresource (= 3.2.8)
-      activesupport (= 3.2.8)
-      bundler (~> 1.0)
-      railties (= 3.2.8)
-    railties (3.2.8)
-      actionpack (= 3.2.8)
-      activesupport (= 3.2.8)
-      rack-ssl (~> 1.3.2)
+    rails (4.1.1)
+      actionmailer (= 4.1.1)
+      actionpack (= 4.1.1)
+      actionview (= 4.1.1)
+      activemodel (= 4.1.1)
+      activerecord (= 4.1.1)
+      activesupport (= 4.1.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.1)
+      sprockets-rails (~> 2.0)
+    railties (4.1.1)
+      actionpack (= 4.1.1)
+      activesupport (= 4.1.1)
       rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (>= 0.14.6, < 2.0)
-    rake (0.8.7)
-    rdoc (3.12)
-      json (~> 1.4)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.2)
     redis (3.1.0)
     redis-namespace (1.5.1)
       redis (~> 3.0, >= 3.0.4)
@@ -92,39 +94,48 @@ GEM
       redis-namespace (~> 1.3)
       sinatra (>= 0.9.2)
       vegas (~> 0.1.2)
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.3)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.3)
-    sinatra (1.3.6)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    safe_yaml (1.0.3)
+    sinatra (1.4.5)
       rack (~> 1.4)
-      rack-protection (~> 1.3)
-      tilt (~> 1.3, >= 1.3.3)
-    sprockets (2.1.3)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    sprockets (2.12.1)
       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.11)
+    sprockets-rails (2.1.3)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    thor (0.19.1)
+    thread_safe (0.3.3)
+    tilt (1.4.1)
+    treetop (1.4.15)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.33)
+    tzinfo (1.1.0)
+      thread_safe (~> 0.1)
     vegas (0.1.11)
       rack (>= 1.0.0)
-    webmock (1.8.11)
-      addressable (>= 2.2.7)
-      crack (>= 0.1.7)
+    webmock (1.18.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   heroku-resque-workers-scaler!
+  psych
   rails
   rake
   rspec

data/{README.rdoc → README.md}

@@ -28,8 +28,19 @@ You can test when executed this :
 ```
 	HEROKU_API_KEY=your_api_key HEROKU_APP_NAME=your_app_name *** bundle exec *** rake spec
 ```
-You can changes thresholds and environments of execution into scaler_config.yml or on your project on config/scaler_config.yml
-
+You can change the thresholds, environments of execution and the name of your worker process in your project on config/scaler_config.yml
+
+Exmple YAML file contents:
+
+    thresholds:
+    - :workers: 1
+      :job_count: 1
+    - :workers: 2
+      :job_count: 15
+    environments:
+      - production
+    worker_name: resque
+    
 I just bundled it into a gem for easy inclusion into other projects.
 
 #### Usage

data/heroku-resque-workers-scaler.gemspec

@@ -17,10 +17,11 @@ Gem::Specification.new do |gem|
   gem.version       = HerokuResqueAutoScale::VERSION
 
   gem.add_runtime_dependency 'resque'
-  gem.add_runtime_dependency 'heroku-api'
+  gem.add_runtime_dependency 'platform-api'
   
   gem.add_development_dependency 'rails'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'webmock'
   gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'psych'
 end

data/lib/heroku-resque-workers-scaler/config.rb

@@ -6,7 +6,7 @@ module HerokuResqueAutoScale
     
     def thresholds
       @thresholds ||= begin
-        if config_file?
+        if config_file? && config.has_key?('thresholds')
           config['thresholds']
         else
           [{workers:1,job_count:1},{workers:2,job_count:15},{workers:3,job_count:25},{workers:4,job_count:40},{workers:5,job_count:60}]
@@ -16,13 +16,23 @@ module HerokuResqueAutoScale
     
     def environments
       @environments ||= begin
-        if config_file?
+        if config_file? && config.has_key?('environments')
           config['environments']
         else
           [ 'production' ]
         end
       end
     end
+
+    def worker_name
+      @worker_name ||= begin
+        if config_file? && config.has_key?('worker_name')
+          config['worker_name']
+        else
+          'worker'
+        end
+      end
+    end
     
     private 
     

data/lib/heroku-resque-workers-scaler/scaler.rb

@@ -1,22 +1,27 @@
-require 'heroku-api'
+require 'platform-api'
 
 module HerokuResqueAutoScale
   module Scaler
 
     class << self
-      @@heroku = Heroku::API.new(api_key: ENV['HEROKU_API_KEY'])
+      @@heroku = PlatformAPI.connect(ENV['HEROKU_API_KEY'])
 
       def workers
-        return nil unless authorised?
-        @@heroku.get_app(ENV['HEROKU_APP_NAME']).body['workers'].to_i
+        return -1 unless authorized?
+        result = @@heroku.formation.info(app_name, worker_name)
+        result['quantity']
       end
 
-      def workers=(qty)
-        return unless authorised?
-        if safe_mode? and down? qty
-          return unless safer?
+      def workers=(quantity)
+        return unless authorized?
+
+        quantity = quantity.to_i
+
+        if safe_mode? and setting_this_number_of_workers_will_scale_down? quantity
+          return unless all_jobs_hve_been_processed?
         end
-        @@heroku.post_ps_scale(ENV['HEROKU_APP_NAME'], 'worker', qty.to_i)
+        result = @@heroku.formation.update(app_name, worker_name, {quantity: quantity})
+        result['quantity'] == quantity
       end
 
       def job_count
@@ -29,24 +34,32 @@ module HerokuResqueAutoScale
 
       protected
 
-      def down? qty
-        qty < workers
+      def app_name
+        ENV['HEROKU_APP_NAME']
+      end
+
+      def setting_this_number_of_workers_will_scale_down? quantity
+        quantity < workers
       end
 
       def safe_mode?
         ENV['SAFE_MODE'] and ENV['SAFE_MODE'] == 'true'
       end
 
-      def safer?
+      def all_jobs_hve_been_processed?
         job_count + working_job_count == 0
       end
 
       private
 
-      def authorised?
+      def authorized?
         HerokuResqueAutoScale::Config.environments.include? Rails.env.to_s
       end
 
+      def worker_name
+        HerokuResqueAutoScale::Config.worker_name
+      end
+
     end
   end
 

data/lib/heroku-resque-workers-scaler/version.rb

@@ -1,3 +1,3 @@
 module HerokuResqueAutoScale
-  VERSION = '0.1.9'
+  VERSION = '0.2.0'
 end

data/spec/heroku-resque-workers-scaler/config_spec.rb

@@ -1,8 +1,28 @@
 require 'spec_helper'
 
 describe HerokuResqueAutoScale::Config do
-  it { HerokuResqueAutoScale::Config.thresholds.should be_instance_of Array }
-  it { HerokuResqueAutoScale::Config.environments.should eql ['production','staging'] }
+
+  before(:each) do
+    HerokuResqueAutoScale.send(:remove_const, 'Config')
+    load 'lib/heroku-resque-workers-scaler/config.rb'
+  end
+
+  context 'using the supplied config file' do
+    it { HerokuResqueAutoScale::Config.thresholds.should be_instance_of Array }
+    it { HerokuResqueAutoScale::Config.environments.should eql ['production','staging'] }
+    it { HerokuResqueAutoScale::Config.worker_name.should eql 'worker' }
+  end
+
+  context 'with missing config values' do
+    before :each do
+      HerokuResqueAutoScale::Config.stub(:config).and_return({})
+    end
+
+    it { HerokuResqueAutoScale::Config.thresholds.should be_instance_of Array }
+    it { HerokuResqueAutoScale::Config.environments.should eql ['production'] }
+    it { HerokuResqueAutoScale::Config.worker_name.should eql 'worker' }
+
+  end
 end
   
   

data/spec/heroku-resque-workers-scaler/scaler_spec.rb

@@ -1,36 +1,51 @@
 require 'spec_helper'
 
-# HEROKU_API_KEY=your_api_key HEROKU_APP_NAME=your_app_name bundle exec rake spec
 describe HerokuResqueAutoScale::Scaler do
 
-  context 'authorised' do
-    before { HerokuResqueAutoScale::Scaler.stub authorised?: true }
-    context 'unsafe mode' do
-      before { HerokuResqueAutoScale::Scaler.stub safe_mode?: false }
-  
-      context 'get number of workers' do
+  context 'when authorised' do
+
+    before { HerokuResqueAutoScale::Scaler.stub(:authorized?).and_return(true) }
+
+    context 'with safe mode disabled' do
+
+      before { HerokuResqueAutoScale::Scaler.stub(:safe_mode?).and_return(false) }
+
+      describe 'get number of workers' do
         before do
-          stub_request(:get, "https://api.heroku.com/apps/your_app_name").
-            with(:headers => {'Accept'=>'application/json', 'Accept-Encoding'=>'gzip', 'Authorization'=>'Basic OnlvdXJfYXBpX2tleQ==', \
-              'Host'=>'api.heroku.com:443', 'User-Agent'=>'heroku-rb/0.3.5', 'X-Ruby-Platform'=>'x86_64-darwin12.2.0', 'X-Ruby-Version'=>'1.9.3'}).
-              to_return(:status => 200, :body => JSON.generate({ workers: '42' }), :headers => {})
+          response_hash = {
+              'command' => 'bundle exec rails server -p $PORT',
+              'created_at' => '2012-01-01T12:00:00Z',
+              'id' => '01234567-89ab-cdef-0123-456789abcdef',
+              'quantity' => 42,
+              'size' => '1X',
+              'type' => 'web',
+              'updated_at' => '2012-01-01T12:00:00Z'
+          }
+          PlatformAPI::Client.any_instance.stub_chain(:formation, :info).and_return(response_hash)
         end
   
         it { HerokuResqueAutoScale::Scaler.workers.should eql 42 }
       end
   
-      context 'set number of workers' do
+      describe 'set number of workers' do
         before do
-          stub_request(:post, "https://api.heroku.com/apps/your_app_name/ps/scale?qty=69&type=worker").
-            with(:headers => {'Accept'=>'application/json', 'Accept-Encoding'=>'gzip', 'Authorization'=>'Basic OnlvdXJfYXBpX2tleQ==', \
-              'Host'=>'api.heroku.com:443', 'User-Agent'=>'heroku-rb/0.3.5', 'X-Ruby-Platform'=>'x86_64-darwin12.2.0', 'X-Ruby-Version'=>'1.9.3'}).
-              to_return(:status => 200, :body => "", :headers => {})
+          response_hash = {
+              'command' => 'bundle exec rails server -p $PORT',
+              'created_at' => '2012-01-01T12:00:00Z',
+              'id' => '01234567-89ab-cdef-0123-456789abcdef',
+              'quantity' => 69,
+              'size' => '1X',
+              'type' => 'web',
+              'updated_at' => '2012-01-01T12:00:00Z'
+          }
+
+          PlatformAPI::Client.any_instance.stub_chain(:formation, :update).and_return(response_hash)
         end
     
-        it { HerokuResqueAutoScale::Scaler.send(:workers=, '69') }
+        it { HerokuResqueAutoScale::Scaler.send(:workers=, 69).should be_true }
       end
   
-      context 'ask for job and working count' do
+      describe 'ask for job and working count' do
         before { Resque.stub(info: { pending: '16', working: '61' }) }
     
         it { HerokuResqueAutoScale::Scaler.job_count.should eql 16 }
@@ -38,30 +53,31 @@ describe HerokuResqueAutoScale::Scaler do
       end
     end
     
-    context 'on safe mode' do
+    context 'with safe mode enabled' do
       before { HerokuResqueAutoScale::Scaler.stub safe_mode?: true }
-      
-      context 'try unsafe action' do
-        before { HerokuResqueAutoScale::Scaler.stub safer?: false, down?: true }
-        
-        describe 'should not trigger action' do
-          
-          it { HerokuResqueAutoScale::Scaler.send(:workers=, '69').should be_nil } # Webmock do nothing here
+
+      context 'when about to scale down' do
+        before { HerokuResqueAutoScale::Scaler.stub setting_this_number_of_workers_will_scale_down?: true }
+
+        context 'when there are some jobs left to process' do
+          before { HerokuResqueAutoScale::Scaler.stub all_jobs_hve_been_processed?: false }
+
+          it 'does not trigger the API call' do
+            PlatformAPI::Client.any_instance.should_not_receive(:formation)
+            HerokuResqueAutoScale::Scaler.send(:workers=, '69')
+          end
         end
-      end
-      
-      context 'try safe action' do
-        before { HerokuResqueAutoScale::Scaler.stub safer?: true, down?: true }
-        
-        describe 'should not trigger action' do
-          before do
-            stub_request(:post, "https://api.heroku.com/apps/your_app_name/ps/scale?qty=69&type=worker").
-              with(:headers => {'Accept'=>'application/json', 'Accept-Encoding'=>'gzip', 'Authorization'=>'Basic OnlvdXJfYXBpX2tleQ==', \
-                'Host'=>'api.heroku.com:443', 'User-Agent'=>'heroku-rb/0.3.5', 'X-Ruby-Platform'=>'x86_64-darwin12.2.0', 'X-Ruby-Version'=>'1.9.3'}).
-                to_return(:status => 200, :body => "", :headers => {})
+
+        context 'when there are no jobs left to process' do
+          before { HerokuResqueAutoScale::Scaler.stub all_jobs_hve_been_processed?: true }
+
+          describe 'should trigger action' do
+            it 'does not trigger the API call' do
+              mock_client = double(PlatformAPI::Client).as_null_object
+              PlatformAPI::Client.any_instance.should_receive(:formation).and_return(mock_client)
+              HerokuResqueAutoScale::Scaler.send(:workers=, '69')
+            end
           end
-          
-          it { HerokuResqueAutoScale::Scaler.send(:workers=, '69') }
         end
       end
       

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: heroku-resque-workers-scaler
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - Mark Quezada
@@ -26,7 +26,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: heroku-api
+  name: platform-api
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,6 +95,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Auto scale your resque workers on Heroku.
 email:
 - mark@mirthlab.com
@@ -111,10 +125,8 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
-- heroku-resque-workers-scaler-0.1.5.gem
-- heroku-resque-workers-scaler-0.1.6.gem
 - heroku-resque-workers-scaler.gemspec
 - lib/heroku-resque-workers-scaler.rb
 - lib/heroku-resque-workers-scaler/config.rb