workless 1.2.3 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 247a947751bcae149a8352caca4aec7e96bd13e8
-  data.tar.gz: 34249b4154b3537e0ad4aa6203b66edebb6a9240
+  metadata.gz: 473c0f1c1861f33cc1871d549c90263baeb7c793
+  data.tar.gz: 2473df42e988787e5f231795e5066ef8d44d245f
 SHA512:
-  metadata.gz: 2c7dd90c1ce19d602d5f0f27b94d7929b3b9f5495bdd61a2c30eb5f9dd5f5efd715883479a61d186d80051fdaa7a34a33f5dc8cbc61390d257aa5eec53880dd6
-  data.tar.gz: 1c1bc50df460cdd7274552deb1be04022b3d7b67a9677ceabbea6c32bca8c47364b72a562711ad41ba279d18e35ba7e9511b93c1491ac5c7759b5cece381acf0
+  metadata.gz: 01d825fe3475a68120e35026736d51d86c0f5174c631b0d4e7c65e012a5897de29b8b86232c9fd992f9d8b4d6de31fc61367bec424817606e1aca70e108b3d41
+  data.tar.gz: 92797b2ad0176b0d2e6ef465b31db5357994b475f7064fa95ebb0cb7fa23efa1e7c28211146331651db5b306e14b9b1617c008027a0d6c032376481d1f0c9650

data/README.md

@@ -9,8 +9,19 @@ It is designed to be used when you're using Heroku as a host and have the need t
 
 By adding the gem to your project and configuring our Heroku app with some config variables workless should do the rest.
 
+:warning: **[The Legacy API will be sunset on April 15th, 2017](https://devcenter.heroku.com/changelog-items/862)** :warning:
+Please upgrade to version 2.0.0 as soon as you can. Version 2.0.0 is released on March 1st, 2017.
+
+## Heroku Stack Heroku-16 update
+Version 2.2.0 changed the config for setting the Heroku API key. This will now reside in WORKLESS_API_KEY. Please change this key in your Heroku setup when upgrading this gem!
+
 ## Updates
 
+* Version 2.2.0 Revitalized by @davidakachaos through his workless_revived project, now merged for a 2.2.0 release.
+* Version 1.3.0 DROPS SUPPORT FOR OLDER RUBY AND RAILS VERSIONS!
+* Version 1.2.5 Added middleware to check on delayed jobs, fixed Rails 5 support
+* Version 1.2.4 drops support for older versions!
+* Version 1.2.3 replaces multiple commit callback with two callbacks for compatibility by @lostboy
 * Version 1.2.2 includes after_commit fix by @collectiveip
 * Version 1.2.1 includes support for Rails 4 & DJ 4 by @florentmorin
 * Version 1.2.0 includes new support for Sequel by @davidakachaos
@@ -22,45 +33,39 @@ By adding the gem to your project and configuring our Heroku app with some confi
 
 ## Compatibility
 
-Workless should work correctly with Rubies 1.8.7, ree, 1.9.2 and 1.9.3. It is compatible with Delayed Job since version 2.0.7 up to the latest version 3.0.1, the table below shows tested compatibility with ruby, rails and delayed_job
+Workless should work correctly with Rubies 2.0.0 and up. It is compatible with Delayed Job since version 2.0.7 up to the latest version 4.1.2, the table below shows tested compatibility with ruby, rails and delayed_job
 
 Ruby | Rails  | Delayed Job
 ---------- | ------ | -----
-1.8.7-ree  | 2.1.14 | 2.0.7
-1.9.2      | 3.2    | 2.1.4
-1.9.2      | 3.2    | 3.0.1
+2.2.5      | 4.2    | 2.1.4
+2.3.1      | 5.0    | 4.1.2
+2.4.1      | 5.1    | 4.1.3
 
 ## Installation
 
-Add the workless gem and the delayed_job gem to your project Gemfile and update your bundle. Its is recommended to specify the gem version for delayed_job especially if you are using rails 2.3.x which doesn't work with the latest delayed_job
-
-### For rails 2.3.x the latest compatible delayed_job is 2.0.7
-
-<pre>
-gem "delayed_job", "2.0.7"
-gem "workless", "~> 1.1.3"
-</pre>
+Add the workless gem and the delayed_job gem to your project Gemfile and update your bundle. Its is recommended to specify the gem version for delayed_job
 
-### For rails 3.x with delayed_job 2.1.x
+### For rails 4.x with latest delayed_job 3.x using active record
 
 <pre>
-gem "delayed_job", "~> 2.1.4"
-gem "workless", "~> 1.1.3"
+gem "delayed_job_active_record"
+gem "workless", "~> 2.2.0"
 </pre>
 
-### For rails 3.x with latest delayed_job 3.x using active record
+### For rails 5.x with latest delayed_job 3.x using active record
 
 <pre>
 gem "delayed_job_active_record"
-gem "workless", "~> 1.1.3"
+gem "workless", "~> 2.0.0"
 </pre>
 
-If you don't specify delayed_job in your Gemfile workless will bring it in, most likely the latest version (3.0.1)
+
+If you don't specify delayed_job in your Gemfile workless will bring it in, most likely the latest version (4.1.2)
 
 Add your Heroku app name / [API key](https://devcenter.heroku.com/articles/authentication) as config vars to your Heroku instance.
 
 <pre>
-heroku config:add HEROKU_API_KEY=yourapikey APP_NAME=yourherokuappname
+heroku config:add WORKLESS_API_KEY=yourapikey APP_NAME=yourherokuappname
 </pre>
 
 ## Failing Jobs
@@ -72,7 +77,7 @@ In the case of failed jobs Workless will only shut down the dj worker if all att
 Workless can be disabled by using the null scaler that will ignore the workers requests to scale up and down. In an environment file add this in the config block:
 
 <pre>
-config.after_initialize do 
+config.after_initialize do
   Delayed::Job.scaler = :null
 end
 </pre>
@@ -81,11 +86,11 @@ There are three other scalers included. Note that if you are running on the Aspe
 
 <pre>
 Delayed::Job.scaler = :heroku
-Delayed::Job.scaler = :heroku_cedar
+Delayed::Job.scaler = :heroku
 Delayed::Job.scaler = :local
 </pre>
 
-The local scaler uses @adamwiggins rush library http://github.com/adamwiggins/rush to start and stop workers on a local machine. The local scaler also relies on script/delayed_job (which in turn requires the daemon gem). If you have been using foreman to run your workers, go back and see the delayed_job [setup instructions](https://github.com/collectiveidea/delayed_job/blob/master/README.md). 
+The local scaler uses @adamwiggins rush library http://github.com/adamwiggins/rush to start and stop workers on a local machine. The local scaler also relies on script/delayed_job (which in turn requires the daemon gem). If you have been using foreman to run your workers, go back and see the delayed_job [setup instructions](https://github.com/collectiveidea/delayed_job/blob/master/README.md).
 
 The heroku scaler works on the Aspen and Bamboo stacks while the heroku_cedar scaler only works on the new Cedar stack.
 
@@ -109,7 +114,7 @@ In this example, it will scale up to a maximum of 10 workers, firing up 1 worker
 - A `destroy` callback stops the worker.
 
 ## Note on Patches/Pull Requests
- 
+
 * Please fork the project.
 * Make your feature addition or bug fix.
 * Commit, do not mess with rakefile, version, or history.
@@ -118,4 +123,8 @@ In this example, it will scale up to a maximum of 10 workers, firing up 1 worker
 
 ## Copyright
 
-Copyright (c) 2010 lostboy. See LICENSE for details.
+Copyright (c) 2010 lostboy.
+Copyright (c) 2016 davidakachaos.
+Copyright (c) 2017 lostboy && davidakachaos.
+
+See LICENSE for details.

data/lib/workless.rb

@@ -1,4 +1,6 @@
-require "heroku-api"
-require File.dirname(__FILE__) + "/workless/scalers/base"
-require File.dirname(__FILE__) + "/workless/scaler"
-require File.dirname(__FILE__) + "/workless/railtie" if defined?(Rails::Railtie)
+# frozen_string_literal: true
+
+require File.dirname(__FILE__) + '/workless/scalers/base'
+require File.dirname(__FILE__) + '/workless/scaler'
+require File.dirname(__FILE__) + '/workless/middleware/workless_checker' if defined?(Rails::Railtie)
+require File.dirname(__FILE__) + '/workless/railtie' if defined?(Rails::Railtie)

data/lib/workless/initialize.rb

@@ -1,4 +1,6 @@
-Delayed::Worker.max_attempts = 3
+# frozen_string_literal: true
+
+Delayed::Worker.max_attempts ||= 3
 Delayed::Backend::ActiveRecord::Job.send(:include, Delayed::Workless::Scaler) if defined?(Delayed::Backend::ActiveRecord::Job)
 Delayed::Backend::Mongoid::Job.send(:include, Delayed::Workless::Scaler) if defined?(Delayed::Backend::Mongoid::Job)
 Delayed::Backend::MongoMapper::Job.send(:include, Delayed::Workless::Scaler) if defined?(Delayed::Backend::MongoMapper::Job)

data/lib/workless/middleware/workless_checker.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class WorklessChecker
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    status, headers, response = @app.call(env)
+    return [status, headers, response] if file?(headers) || empty?(response)
+
+    Delayed::Job.scaler.up unless Delayed::Job.scaler.jobs.empty?
+
+    [status, headers, response]
+  end
+
+  # fix issue if response's body is a Proc
+  def empty?(response)
+    # response may be ["Not Found"], ["Move Permanently"], etc.
+    (response.is_a?(Array) && response.size <= 1) ||
+      !response.respond_to?(:body) ||
+      !response.body.respond_to?(:empty?) ||
+      response.body.empty?
+  end
+
+  # if send file?
+  def file?(headers)
+    headers['Content-Transfer-Encoding'] == 'binary'
+  end
+end

data/lib/workless/railtie.rb

@@ -3,8 +3,9 @@ require 'delayed_job'
 
 module Delayed
   class Railtie < Rails::Railtie
-    initializer :after_initialize do
+    initializer :after_initialize do |config|
       require 'workless/initialize'
+      config.middleware.use WorklessChecker
     end
   end
 end

data/lib/workless/scaler.rb

@@ -1,20 +1,26 @@
+# frozen_string_literal: true
+
 module Delayed
   module Workless
     module Scaler
-
-      autoload :Heroku,      "workless/scalers/heroku"
-      autoload :HerokuCedar, "workless/scalers/heroku_cedar"
-      autoload :Local,       "workless/scalers/local"
-      autoload :Null,        "workless/scalers/null"
+      autoload :Heroku,      'workless/scalers/heroku'
+      autoload :Local,       'workless/scalers/local'
+      autoload :Null,        'workless/scalers/null'
 
       def self.included(base)
         base.send :extend, ClassMethods
         if base.to_s =~ /ActiveRecord/
           base.class_eval do
-            after_commit "self.class.scaler.down", :on => :update, :if => Proc.new {|r| !r.failed_at.nil? }
-            after_commit "self.class.scaler.down", :on => :destroy, :if => Proc.new {|r| r.destroyed? or !r.failed_at.nil? }
-            after_commit "self.class.scaler.up", :on => :create
-          end          
+            after_commit(on: :update, if: proc { |r| !r.failed_at.nil? }) do 
+              self.class.scaler.down
+            end
+            after_commit(on: :destroy, if: proc { |r| r.destroyed? || !r.failed_at.nil? }) do
+              self.class.scaler.down
+            end
+            after_commit(on: :create) do 
+              self.class.scaler.up
+            end
+          end
         elsif base.to_s =~ /Sequel/
           base.send(:define_method, 'after_destroy') do
             super
@@ -30,19 +36,19 @@ module Delayed
           end
         else
           base.class_eval do
-            after_destroy "self.class.scaler.down"
-            after_create "self.class.scaler.up"
-            after_update "self.class.scaler.down", :unless => Proc.new {|r| r.failed_at.nil? }
+            after_destroy 'self.class.scaler.down'
+            after_create 'self.class.scaler.up'
+            after_update 'self.class.scaler.down', unless: proc { |r| r.failed_at.nil? }
           end
         end
       end
 
       module ClassMethods
         def scaler
-          @scaler ||= if ENV.include?("HEROKU_API_KEY")
-            Scaler::HerokuCedar
-          else
-            Scaler::Local
+          @scaler ||= if ENV.include?('WORKLESS_API_KEY')
+                        Scaler::Heroku
+                      else
+                        Scaler::Local
           end
         end
 
@@ -50,8 +56,6 @@ module Delayed
           @scaler = "Delayed::Workless::Scaler::#{scaler.to_s.camelize}".constantize
         end
       end
-
     end
-
   end
 end

data/lib/workless/scalers/base.rb

@@ -1,27 +1,21 @@
+# frozen_string_literal: true
+
 require 'delayed_job'
 
 module Delayed
   module Workless
     module Scaler
-  
       class Base
         def self.jobs
-          if Rails.version >= "3.0.0"
-            Delayed::Job.where(:failed_at => nil)
-          else
-            Delayed::Job.all(:conditions => { :failed_at => nil })
-          end
+          Delayed::Job.where(failed_at: nil)
         end
       end
 
       module HerokuClient
-
         def client
-          @client ||= ::Heroku::API.new(:api_key => ENV['HEROKU_API_KEY'])
+          @client ||= ::PlatformAPI.connect(ENV['WORKLESS_API_KEY'])
         end
-
       end
-
     end
   end
 end

data/lib/workless/scalers/heroku.rb

@@ -1,27 +1,55 @@
-require 'heroku-api'
+# frozen_string_literal: true
+
+require 'platform-api'
 
 module Delayed
   module Workless
     module Scaler
-
       class Heroku < Base
-
         extend Delayed::Workless::Scaler::HerokuClient
 
         def self.up
-          client.put_workers(ENV['APP_NAME'], 1) if self.workers == 0
+          return unless workers_needed > min_workers && workers < workers_needed
+          updates = { "quantity": workers_needed }
+          client.formation.update(ENV['APP_NAME'], 'worker', updates)
         end
 
         def self.down
-          client.put_workers(ENV['APP_NAME'], 0) unless self.jobs.count > 0 or self.workers == 0
+          return if workers == workers_needed
+          updates = { "quantity": workers_needed }
+          client.formation.update(ENV['APP_NAME'], 'worker', updates)
         end
 
         def self.workers
-          client.get_ps(ENV['APP_NAME']).body.count { |p| p["process"] =~ /worker\.\d?/ }
+          client.formation.info(ENV['APP_NAME'], 'worker')['quantity'].to_i
         end
 
-      end
+        # Returns the number of workers needed based on the current number of pending jobs and the settings defined by:
+        #
+        # ENV['WORKLESS_WORKERS_RATIO']
+        # ENV['WORKLESS_MAX_WORKERS']
+        # ENV['WORKLESS_MIN_WORKERS']
+        #
+        def self.workers_needed
+          [[(jobs.count.to_f / workers_ratio).ceil, max_workers].min, min_workers].max
+        end
 
+        def self.workers_ratio
+          if ENV['WORKLESS_WORKERS_RATIO'].present? && (ENV['WORKLESS_WORKERS_RATIO'].to_i != 0)
+            ENV['WORKLESS_WORKERS_RATIO'].to_i
+          else
+            100
+          end
+        end
+
+        def self.max_workers
+          ENV['WORKLESS_MAX_WORKERS'].present? ? ENV['WORKLESS_MAX_WORKERS'].to_i : 1
+        end
+
+        def self.min_workers
+          ENV['WORKLESS_MIN_WORKERS'].present? ? ENV['WORKLESS_MIN_WORKERS'].to_i : 0
+        end
+      end
     end
   end
 end

data/lib/workless/scalers/local.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require 'rush'
 
 module Delayed
   module Workless
     module Scaler
       class Local < Base
-
         def self.executable_prefix
           if defined? Delayed::Compatibility.executable_prefix
             Delayed::Compatibility.executable_prefix
@@ -14,22 +15,22 @@ module Delayed
         end
 
         def self.up
-          if self.workers == 0
-            Rush::Box.new[Rails.root].bash("#{executable_prefix}/delayed_job start -i workless", :background => true)
+          if workers == 0
+            Rush::Box.new[Rails.root].bash("#{executable_prefix}/delayed_job start -i workless", background: true)
             sleep 1
           end
           true
         end
 
         def self.down
-          if self.workers > 0 and jobs.count == 0
-            Rush::Box.new[Rails.root].bash("#{executable_prefix}/delayed_job stop -i workless", :background => true)
+          if workers > 0 && jobs.count == 0
+            Rush::Box.new[Rails.root].bash("#{executable_prefix}/delayed_job stop -i workless", background: true)
           end
           true
         end
 
         def self.workers
-          Rush::Box.new.processes.filter(:cmdline => /delayed_job start -i workless|delayed_job.workless/).size
+          Rush::Box.new.processes.filter(cmdline: /delayed_job start -i workless|delayed_job.workless/).size
         end
       end
     end

data/lib/workless/scalers/null.rb

@@ -1,17 +1,15 @@
+# frozen_string_literal: true
+
 module Delayed
   module Workless
     module Scaler
-
       class Null < Base
-      
         def self.up
         end
 
         def self.down
         end
-
       end
-      
     end
   end
 end

data/rails/init.rb

@@ -1 +1,3 @@
-require File.dirname(__FILE__) + "/../lib/workless/initialize"
+# frozen_string_literal: true
+
+require File.dirname(__FILE__) + '/../lib/workless/initialize'

metadata

@@ -1,123 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: workless
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 2.2.0
 platform: ruby
 authors:
+- davidakachaos
 - lostboy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-06-30 00:00:00.000000000 Z
+date: 2017-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: heroku-api
+  name: platform-api
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rush
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: delayed_job
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.7
 - !ruby/object:Gem::Dependency
   name: rspec
   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: Extension to Delayed Job to enable workers to scale up when needed
-email: paul.crabtree@gmail.com
+email: davidakachaos@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- rails/init.rb
+- LICENSE
+- README.md
+- lib/workless.rb
 - lib/workless/initialize.rb
+- lib/workless/middleware/workless_checker.rb
 - lib/workless/railtie.rb
 - lib/workless/scaler.rb
 - lib/workless/scalers/base.rb
 - lib/workless/scalers/heroku.rb
-- lib/workless/scalers/heroku_cedar.rb
 - lib/workless/scalers/local.rb
 - lib/workless/scalers/null.rb
-- lib/workless.rb
-- LICENSE
-- README.md
+- rails/init.rb
 homepage: http://github.com/lostboy/workless
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message: |2
+
+  Workless 2.2.0 introduces a backwards-incompatible change!
+  Please update your Heroku config to use WORKLESS_API_KEY instead of HEROKU_API_KEY!!
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Use delayed job workers only when theyre needed on Heroku

data/lib/workless/scalers/heroku_cedar.rb

@@ -1,49 +0,0 @@
-require 'heroku-api'
-
-module Delayed
-  module Workless
-    module Scaler
-      class HerokuCedar < Base
-        extend Delayed::Workless::Scaler::HerokuClient
-
-        def self.up
-          client.post_ps_scale(ENV['APP_NAME'], 'worker', self.workers_needed) if self.workers_needed > self.min_workers and self.workers < self.workers_needed
-        end
-
-        def self.down
-          client.post_ps_scale(ENV['APP_NAME'], 'worker', self.min_workers) unless self.jobs.count > 0 or self.workers == self.min_workers
-        end
-
-        def self.workers
-          client.get_ps(ENV['APP_NAME']).body.count { |p| p["process"] =~ /worker\.\d?/ }
-        end
-
-        # Returns the number of workers needed based on the current number of pending jobs and the settings defined by:
-        #
-        # ENV['WORKLESS_WORKERS_RATIO']
-        # ENV['WORKLESS_MAX_WORKERS']
-        # ENV['WORKLESS_MIN_WORKERS']
-        #
-        def self.workers_needed
-          [[(self.jobs.count.to_f / self.workers_ratio).ceil, self.max_workers].min, self.min_workers].max
-        end
-
-        def self.workers_ratio
-          if ENV['WORKLESS_WORKERS_RATIO'].present? && (ENV['WORKLESS_WORKERS_RATIO'].to_i != 0)
-            ENV['WORKLESS_WORKERS_RATIO'].to_i
-          else
-            100
-          end
-        end
-
-        def self.max_workers
-          ENV['WORKLESS_MAX_WORKERS'].present? ? ENV['WORKLESS_MAX_WORKERS'].to_i : 1
-        end
-
-        def self.min_workers
-          ENV['WORKLESS_MIN_WORKERS'].present? ? ENV['WORKLESS_MIN_WORKERS'].to_i : 0
-        end
-      end
-    end
-  end
-end