work_smarter 1.0

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in work_smarter.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    work_smarter (1.0)
+      delayed_job (~> 3.0.3)
+      heroku-api (~> 0.3.4)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    delayed_job (3.0.3)
+      activesupport (~> 3.0)
+    excon (0.16.2)
+    heroku-api (0.3.4)
+      excon (~> 0.16.1)
+    i18n (0.6.0)
+    multi_json (1.3.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  work_smarter!

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012, Deniz Okcu
+
+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.markdown

@@ -0,0 +1,52 @@
+# Work_smarter
+
+Work_smarter is a simple wrapper for Delayed::Job that helps you autoscale workers when deployed on [Heroku](http://www.heroku.com). It came about for an upcoming project of [ours](http://www.involved.com.au), which only required the occasional background worker.
+
+__Please note:__ This is still very early days for Work_smarter, there's very little (read: zero) test coverage - and we've yet to even put it into production.
+
+# Configuration
+
+Setup delayed_job as per [the instructions](http://docs.heroku.com/delayed-job) on Heroku.
+
+Add Work_smarter to your Gemfile:
+
+  gem "work_smarter"
+
+Add a `/config/work_smarter.yml` file to your Rails 3 project directory and add the following:
+
+  defaults: &defaults
+    max_workers: 1
+    min_workers: 0
+    application_name: my_heroku_application
+    api_key: your_api_key
+    backgroundjob_name: worker #default should be 'worker'
+  
+  development:
+    <<: *defaults
+
+  test:
+    <<: *defaults
+
+  production:
+    <<: *defaults
+  
+# Usage
+
+Work_smarter is set up to (try and) be as abstract as possible. Queuing a function works similar to delayed_job, just call:
+
+  Work_smarter.queue object, :function, [arg1, arg2]
+
+For example:
+  
+  Work_smarter.queue @image, :resize, {:width => 900, :height => 450}
+  # -- or --
+  Work_smarter.queue UserMailer.send_registration_notification(@user), :deliver
+
+Work_smarter will automatically add and remove workers as the queue fills up and empties, respectively.
+
+# Notes
+
+This is a modified version of the Komodo gem. I changed some behaviour because the Komodo gem used deprecated Heroku commands. 
+I renamed and created this gem because i had namespace issues with a fork of the Komodo gem. 
+
+As stated above, this is really a pre-alpha of Work_smarter, as such the scaling is very basic; Work_smarter just ramps straight up to the user-configured maximum.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/work_smarter.rb

@@ -0,0 +1,34 @@
+class Work_smarter < Struct.new(:obj, :func, :args)  
+  # delayed_job wrapper, creates a new monitored job and queues it
+  def self.queue(obj, func, args = [])
+    Work_smarter.configure unless defined?(@@config)
+    Delayed::Job.enqueue Work_smarter.new(obj, func, args)
+  end
+  
+  # nothing of note here
+  def perform
+    obj.send(func, args)
+  end
+  
+  protected
+  # adds a heroku worker, if required
+  def enqueue(job)
+    if Rails.env == "production" && Delayed::Job.count == 0
+      heroku = Heroku::API.new(:api_key => @@config['api_key']) 
+      heroku.post_ps_scale(@@config['application_name'], @@config['backgroundjob_name'], @@config['max_workers']) 
+    end
+  end
+  
+  # removes heroku workers if queue is empty, or falling below max_workers
+  def after(job)
+    if Rails.env == "production" && Delayed::Job.count == 0
+      heroku = Heroku::API.new(:api_key => @@config['api_key']) 
+      heroku.post_ps_scale(@@config['application_name'], @@config['backgroundjob_name'], @@config['min_workers']) 
+    end
+  end
+  
+  private
+  def self.configure
+    @@config = YAML.load_file("#{Rails.root.to_s}/config/work_smarter.yml")[Rails.env]
+  end
+end

data/work_smarter.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "work_smarter"
+  s.version     = "1.0"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Deniz Okcu"]
+  s.email       = ["deniz@combinio.com"]
+  s.homepage    = "http://github.com/thetron/komodo"
+  s.summary     = %q{work_smarter autoscales delayed_job workers on Heroku}
+  s.description = %q{work_smarter is a updated/modified version of the Komodo gem. It allows you to scale on-demand the number of delayed_job workers on Heroku, based on the length of your queue.}
+  
+  s.add_dependency 'heroku-api',    '~> 0.3.4'
+  s.add_dependency 'delayed_job',   '~> 3.0.3'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: work_smarter
+version: !ruby/object:Gem::Version
+  version: '1.0'
+  prerelease: 
+platform: ruby
+authors:
+- Deniz Okcu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: heroku-api
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+- !ruby/object:Gem::Dependency
+  name: delayed_job
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+description: work_smarter is a updated/modified version of the Komodo gem. It allows
+  you to scale on-demand the number of delayed_job workers on Heroku, based on the
+  length of your queue.
+email:
+- deniz@combinio.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .DS_Store
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.markdown
+- Rakefile
+- lib/work_smarter.rb
+- work_smarter.gemspec
+homepage: http://github.com/thetron/komodo
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: work_smarter autoscales delayed_job workers on Heroku
+test_files: []