rcarvalho-workless 1.0.2.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 lostboy
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,100 @@
+[![Build Status](https://secure.travis-ci.org/lostboy/workless.png?branch=master)](http://travis-ci.org/lostboy/workless)
+
+# Workless
+
+This is an addon for delayed_job (> 2.0.0) http://github.com/collectiveidea/delayed_job
+It is designed to be used when you're using Heroku as a host and have the need to do background work with delayed job but you don't want to leave the workers running all the time as it costs money.
+
+By adding the gem to your project and configuring our Heroku app with some config variables workless should do the rest.
+
+## Update
+
+Version 1.0.0 has been released, this brings compatibility with delayed_job 3 and compatibility with Rails 2.3.x and up.
+
+## 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
+
+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
+
+## 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.0.1"
+</pre>
+
+### For rails 3.x with delayed_job 2.1.x
+
+<pre>
+gem "delayed_job", "~> 2.1.4"
+gem "workless", "~> 1.0.1"
+</pre>
+
+### For rails 3.x with latest delayed_job 3.x using active record
+
+<pre>
+gem "delayed_job_active_record"
+gem "workless", "~> 1.0.1"
+</pre>
+
+If you don't specify delayed_job in your Gemfile workless will bring it in, most likly the latest version (3.0.1)
+
+Add your Heroku username / password as config vars to your Heroku instance, the same one you log in to Heroku with.
+[You may also use your API key as the password](https://github.com/heroku/heroku/issues/103).
+
+<pre>
+heroku config:add HEROKU_USER=yourusername HEROKU_PASSWORD=yourpassword
+</pre>
+
+And for cedar apps add the app name
+
+<pre>
+heroku config:add APP_NAME=yourherokuappname
+</pre>
+
+## Failing Jobs
+
+In the case of failed jobs Workless will only shut down the dj worker if all attempts have been tried. By default Delayed Job will try 25 times to process a job with ever increasing time delays between each unsucessful attempt. Because of this Workless configures Delayed Job to try failed jobs only 3 times to reduce the amount of time a worker can be running while trying to process them.
+
+## Configuration
+
+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 
+  Delayed::Job.scaler = :null
+end
+</pre>
+
+There are three other scalers included. Note that if you are running on the Aspen or Bamboo stacks on Heroku and you don't explicitly specify the scaler, the heroku scaler will be used automatically.
+
+<pre>
+Delayed::Job.scaler = :heroku
+Delayed::Job.scaler = :heroku_cedar
+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 heroku scaler works on the Aspen and Bamboo stacks while the heroku_cedar scaler only works on the new Cedar stack.
+
+## Note on Patches/Pull Requests
+ 
+* Please fork the project, as you can see there are no tests and at present I don't know how to go about adding them so any advice would be welcome.
+* Make your feature addition or bug fix.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request.
+
+## Copyright
+
+Copyright (c) 2010 lostboy. See LICENSE for details.

data/lib/workless.rb

@@ -0,0 +1,4 @@
+require "heroku"
+require File.dirname(__FILE__) + "/workless/scalers/base"
+require File.dirname(__FILE__) + "/workless/scaler"
+require File.dirname(__FILE__) + "/workless/railtie" if defined?(Rails::Railtie)

data/lib/workless/initialize.rb

@@ -0,0 +1,3 @@
+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)

data/lib/workless/railtie.rb

@@ -0,0 +1,10 @@
+require 'rails'
+require 'delayed_job'
+
+module Delayed
+  class Railtie < Rails::Railtie
+    initializer :after_initialize do
+      require 'workless/initialize'
+    end
+  end
+end

data/lib/workless/scaler.rb

@@ -0,0 +1,44 @@
+require 'workless/scalers/heroku'
+require 'workless/scalers/heroku_cedar'
+require 'workless/scalers/local'
+require 'workless/scalers/null'
+
+module Delayed
+  module Workless 
+    module Scaler
+    
+      def self.included(base)
+        base.send :extend, ClassMethods
+        base.class_eval do
+          after_destroy "self.class.scaler.down"
+          before_create "self.class.scaler.up"
+          after_update "self.class.scaler.down", :unless => Proc.new {|r| r.failed_at.nil? }
+        end
+        
+      end
+      
+      module ClassMethods
+        def scaler
+          @scaler ||= if ENV.include?("HEROKU_USER")
+            client = ::Heroku::Client.new(ENV['HEROKU_USER'], ENV['HEROKU_PASSWORD'])
+            case client.info(ENV["APP_NAME"])[:stack]
+            when "cedar"
+              Scaler::HerokuCedar
+            else  
+              Scaler::Heroku
+            end
+          else
+            Scaler::Local
+          end
+        end
+
+        def scaler=(scaler)
+          @scaler = "Delayed::Workless::Scaler::#{scaler.to_s.camelize}".constantize
+        end
+        
+      end
+      
+    end
+    
+  end
+end

data/lib/workless/scalers/base.rb

@@ -0,0 +1,39 @@
+require 'delayed_job'
+
+module Delayed
+  module Workless
+    module Scaler
+  
+      class Base
+        def self.jobs
+          Delayed::Job.all(:conditions => { :failed_at => nil })
+        end
+        
+        def self.calculate_num_workers
+          num_workers = self.workers
+          if num_workers.class == Fixnum
+            job_count = self.jobs.count
+            if job_count > 500
+              return 4 unless num_workers > 3
+            elsif job_count > 200
+              return 3 unless num_workers > 2
+            elsif job_count > 50
+              return 2 unless num_workers > 1
+            elsif job_count > 0
+              return 1 unless num_workers > 0
+            end
+          end
+        end
+      end
+
+      module HerokuClient
+
+        def client
+          @client ||= ::Heroku::Client.new(ENV['HEROKU_USER'], ENV['HEROKU_PASSWORD'])
+        end
+
+      end
+
+    end
+  end
+end

data/lib/workless/scalers/heroku.rb

@@ -0,0 +1,28 @@
+require 'heroku'
+
+module Delayed
+  module Workless
+    module Scaler
+
+      class Heroku < Base
+
+        extend Delayed::Workless::Scaler::HerokuClient
+
+        def self.up
+          nw = self.calculate_num_workers
+          client.set_workers(ENV['APP_NAME'], nw) if nw
+        end
+
+        def self.down
+          client.set_workers(ENV['APP_NAME'], 0) unless self.workers == 0 or self.jobs.count > 0
+        end
+
+        def self.workers
+          client.info(ENV['APP_NAME'])[:workers].to_i
+        end
+
+      end
+
+    end
+  end
+end

data/lib/workless/scalers/heroku_cedar.rb

@@ -0,0 +1,28 @@
+require 'heroku'
+
+module Delayed
+  module Workless
+    module Scaler
+
+      class HerokuCedar < Base
+
+        extend Delayed::Workless::Scaler::HerokuClient
+
+        def self.up
+          nw = self.calculate_num_workers
+          client.ps_scale(ENV['APP_NAME'], :type => 'worker', :qty => nw) if nw
+        end
+
+        def self.down
+          client.ps_scale(ENV['APP_NAME'], :type => 'worker', :qty => 0) unless self.workers == 0 or self.jobs.count > 0
+        end
+
+        def self.workers
+          client.ps(ENV['APP_NAME']).count { |p| p["process"] =~ /worker\.\d?/ }
+        end
+
+      end
+
+    end
+  end
+end

data/lib/workless/scalers/local.rb

@@ -0,0 +1,32 @@
+require 'rush'
+
+module Delayed
+  module Workless
+    module Scaler
+
+      class Local < Base
+
+        def self.up
+          if self.workers == 0
+            Rush::Box.new[Rails.root].bash("script/delayed_job start -i workless", :background => true)
+            sleep 1
+          end
+          true
+        end
+
+        def self.down
+          unless jobs.count > 0 and workers > 0
+            Rush::Box.new[Rails.root].bash("script/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
+        end
+
+      end
+  
+    end
+  end
+end

data/lib/workless/scalers/null.rb

@@ -0,0 +1,17 @@
+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

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/../lib/workless/initialize"

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: rcarvalho-workless
+version: !ruby/object:Gem::Version
+  version: 1.0.2.1
+  prerelease: 
+platform: ruby
+authors:
+- lostboy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-06-30 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &2156064120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156064120
+- !ruby/object:Gem::Dependency
+  name: heroku
+  requirement: &2156063120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156063120
+- !ruby/object:Gem::Dependency
+  name: rush
+  requirement: &2156062120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156062120
+- !ruby/object:Gem::Dependency
+  name: delayed_job
+  requirement: &2156061140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156061140
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2156060360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156060360
+description: Extension to Delayed Job to enable workers to scale up when needed
+email: paul.crabtree@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- rails/init.rb
+- lib/workless/initialize.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
+homepage: http://github.com/lostboy/workless
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Use delayed job workers only when theyre needed on Heroku
+test_files: []