autoscaler 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d9c40f5b4987f7af492eff1ec34d8e02f44b37e
-  data.tar.gz: 56d95752a486f9c581159edbbfe83c0c19758654
+  metadata.gz: ec6a1b37ad89976bcf80edccfd67480c72aee6f0
+  data.tar.gz: c94e28fe7bcd92502be6dbee2cd9fd45b2ecbcb9
 SHA512:
-  metadata.gz: e2e5887494d03fe84f6292b5aff7106239425bce9f7d174e5e9883b8f53c76b64caf03ebd8a384dad42dd392fcf986e292ce6604249ad8aa58c69ed1e5fa5085
-  data.tar.gz: 33402342e76458cc4039947fb69dbc5bad237249daf6512cf8064515cbee1c23549acd9c0fccd77328d063954fa825249c5bae4adf9209763fd1cfaa9bc87045
+  metadata.gz: 6885e017918b53921cffb12aff92b59579ea1023d41f4f5bc5828d6f50dda383a92b5ca8c6320905b72b30bd37bced45c5c39b31d20bfc6647b4f6531fca5733
+  data.tar.gz: 7c3c78d2c162e50a4432e95ea907c39977a5b07fb44433d5d84bfc35dcb9ae75dcddadaff765d67b3b2d3e379046d950aaefd679516e1e04d6bd594655cab8c6

data/CHANGELOG.md

@@ -1,9 +1,14 @@
 # Changelog
 
+## 0.14.0
+
+- Heroku has claimed the `HEROKU_` ENV prefix for Herkou-16 stack. The preferred variables are now `AUTOSCALER_HEROKU_APP` and `AUTOSCALER_HEROKU_ACCESS_TOKEN`. (The complex example has been similarly updated.) The old ENV variables will still be accepted, with a warning, but may be removed in a major release. (HerokuScaler was not updated.)
+- Added an obsolescence warning to HerokuScaler, since the old API is no longer available. It may be removed in a major release.
+
 ## 0.13.0
 
 - Update version spec to Sidekiq 5
-- redis gem implments `call` for something else since 3.3.0, which was confusing duck sniffing.
+- redis gem implements `call` for something else since 3.3.0, which was confusing duck sniffing.
 
 ## 0.12.0
 

data/README.md

@@ -14,10 +14,8 @@ Tested on Ruby 2.1.7 and Heroku Cedar stack.
 
 This gem uses the [Heroku Platform-Api](https://github.com/heroku/platform-api) gem, which requires an OAuth token from Heroku.  It will also need the heroku app name.  By default, these are specified through environment variables.  You can also pass them to `HerokuPlatformScaler` explicitly.
 
-    HEROKU_ACCESS_TOKEN=.....
-    HEROKU_APP=....
-
-Support is still present for [Heroku-Api](https://github.com/heroku/heroku.rb) via `HerokuScaler` and `HEROKU_API_KEY`, but may be removed in a future major version.
+    AUTOSCALER_HEROKU_ACCESS_TOKEN=.....
+    AUTOSCALER_HEROKU_APP=....
 
 Install the middleware in your `Sidekiq.configure_` blocks
 
@@ -65,9 +63,9 @@ You can pass a scaling strategy object instead of the timeout to the server midd
 
 The project is setup to run RSpec with Guard.  It expects a redis instance on a custom port, which is started by the Guardfile.
 
-The HerokuPlatformScaler is not tested by default because it makes live API requests.  Specify `HEROKU_APP` and `HEROKU_ACCESS_TOKEN` on the command line, and then watch your app's logs.
+The HerokuPlatformScaler is not tested by default because it makes live API requests.  Specify `AUTOSCALER_HEROKU_APP` and `AUTOSCALER_HEROKU_ACCESS_TOKEN` on the command line, and then watch your app's logs.
 
-    HEROKU_APP=... HEROKU_ACCESS_TOKEN=... guard
+    AUTOSCALER_HEROKU_APP=... AUTOSCALER_HEROKU_ACCESS_TOKEN=... guard
     heroku logs --app ...
 
 ## Authors

data/examples/complex.rb

@@ -5,7 +5,7 @@ require 'autoscaler/heroku_platform_scaler'
 # This setup is for multiple queues, where each queue has a dedicated process type
 
 heroku = nil
-if ENV['HEROKU_APP']
+if ENV['AUTOSCALER_HEROKU_APP']
   heroku = {}
   scaleable = %w[default import] - (ENV['ALWAYS'] || '').split(' ')
   scaleable.each do |queue|
@@ -13,8 +13,8 @@ if ENV['HEROKU_APP']
     # same as the queue name
     heroku[queue] = Autoscaler::HerokuPlatformScaler.new(
       queue,
-      ENV['HEROKU_ACCESS_TOKEN'],
-      ENV['HEROKU_APP'])
+      ENV['AUTOSCALER_HEROKU_ACCESS_TOKEN'],
+      ENV['AUTOSCALER_HEROKU_APP'])
   end
 end
 
@@ -26,16 +26,16 @@ Sidekiq.configure_client do |config|
   end
 end
 
-# define HEROKU_PROCESS in the Procfile:
+# define AUTOSCALER_HEROKU_PROCESS in the Procfile:
 #
-#    default: env HEROKU_PROCESS=default bundle exec sidekiq -r ./background/boot.rb
-#    import:  env HEROKU_PROCESS=import bundle exec sidekiq -q import -c 1 -r ./background/boot.rb
+#    default: env AUTOSCALER_HEROKU_PROCESS=default bundle exec sidekiq -r ./background/boot.rb
+#    import:  env AUTOSCALER_HEROKU_PROCESS=import bundle exec sidekiq -q import -c 1 -r ./background/boot.rb
 
 Sidekiq.configure_server do |config|
   config.server_middleware do |chain|
-    if heroku && ENV['HEROKU_PROCESS'] && heroku[ENV['HEROKU_PROCESS']]
+    if heroku && ENV['AUTOSCALER_HEROKU_PROCESS'] && heroku[ENV['AUTOSCALER_HEROKU_PROCESS']]
       p "Setting up auto-scaledown"
-      chain.add(Autoscaler::Sidekiq::Server, heroku[ENV['HEROKU_PROCESS']], 60, [ENV['HEROKU_PROCESS']]) # 60 second timeout
+      chain.add(Autoscaler::Sidekiq::Server, heroku[ENV['AUTOSCALER_HEROKU_PROCESS']], 60, [ENV['AUTOSCALER_HEROKU_PROCESS']]) # 60 second timeout
     else
       p "Not scaleable"
     end

data/examples/simple.rb

@@ -5,7 +5,7 @@ require 'autoscaler/heroku_platform_scaler'
 # This is setup for a single queue (default) and worker process (worker)
 
 heroku = nil
-if ENV['HEROKU_APP']
+if ENV['AUTOSCALER_HEROKU_APP']
   heroku = Autoscaler::HerokuPlatformScaler.new
   #heroku.exception_handler = lambda {|exception| MyApp.logger.error(exception)}
 end

data/lib/autoscaler/heroku_platform_scaler.rb

@@ -9,8 +9,18 @@ module Autoscaler
     # @param [String] app Heroku app name
     def initialize(
         type = 'worker',
-        token = ENV['HEROKU_ACCESS_TOKEN'],
-        app = ENV['HEROKU_APP'])
+        token = ENV['AUTOSCALER_HEROKU_ACCESS_TOKEN'],
+        app = ENV['AUTOSCALER_HEROKU_APP'])
+
+      if (token.nil? && ENV['HEROKU_ACCESS_TOKEN'])
+        warn "Autoscaler: ENV AUTOSCALER_HEROKU_ACCESS_TOKEN is now preferred, HEROKU_ACCESS_TOKEN may be removed in a future release"
+        token = ENV['HEROKU_ACCESS_TOKEN']
+      end
+      if (app.nil? && ENV['HEROKU_APP'])
+        warn "Autoscaler: ENV AUTOSCALER_HEROKU_APP is now preferred, HEROKU_APP may be removed in a future release"
+        app = ENV['HEROKU_APP']
+      end
+
       @client = PlatformAPI.connect_oauth(token)
       @type = type
       @app = app

data/lib/autoscaler/heroku_scaler.rb

@@ -3,6 +3,7 @@ require 'autoscaler/counter_cache_memory'
 
 module Autoscaler
   # Wraps the Heroku API to provide just the interface that we need for scaling.
+  #  OBSOLETE: The v1 Heroku API is no longer available, and HerokuScaler will likely be removed in a future major release. Please see current setup instructions and examples for HerokuPlatformScaler.
   class HerokuScaler
     # @param [String] type process type this scaler controls
     # @param [String] key Heroku API key
@@ -11,6 +12,9 @@ module Autoscaler
         type = 'worker',
         key = ENV['HEROKU_API_KEY'],
         app = ENV['HEROKU_APP'])
+
+      warn "Autoscaler: The v1 Heroku API is no longer available, and HerokuScaler will likely be removed in a future major release. Please see current setup instructions and examples for HerokuPlatformScaler."
+
       @client = Heroku::API.new(:api_key => key)
       @type = type
       @app = app

data/lib/autoscaler/version.rb

@@ -1,4 +1,4 @@
 module Autoscaler
   # version number
-  VERSION = "0.13.0"
+  VERSION = "0.14.0"
 end

data/spec/spec_helper.rb

@@ -6,7 +6,7 @@ RSpec.configure do |config|
   config.mock_with :rspec
 
   config.filter_run_excluding :api1 => true unless ENV['HEROKU_API_KEY']
-  config.filter_run_excluding :platform_api => true unless ENV['HEROKU_ACCESS_TOKEN']
+  config.filter_run_excluding :platform_api => true unless ENV['AUTOSCALER_HEROKU_ACCESS_TOKEN'] || ENV['HEROKU_ACCESS_TOKEN']
 end
 
 class TestScaler

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: autoscaler
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Justin Love
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-12 00:00:00.000000000 Z
+date: 2017-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq