governor_background 0.1.0

data/lib/governor_background/delayed/performer.rb

@@ -0,0 +1,13 @@
+module GovernorBackground
+  module Delayed
+    class Performer < Struct.new(:article, :method_name)
+      def perform
+        article.send(method_name)
+      end
+    
+      def error(job, exception)
+        # handle failure
+      end
+    end
+  end
+end

data/lib/governor_background/handler.rb

@@ -0,0 +1,34 @@
+module GovernorBackground
+  class Handler
+    class << self
+      def run_in_background(object, method)
+        job = if delayed_job?
+          Delayed::Job.new(object, method, ::Delayed::Job.enqueue(Delayed::Performer.new(object, method)))
+        elsif resque?
+          resource_key, id = object.class.name.tableize.to_sym, object.id
+          if resque_with_status?
+            require File.expand_path('../resque/performer_with_state',  __FILE__)
+            Resque::Job.new(object, method, Resque::PerformerWithState.create(:resource => resource_key, :id => id, :method_name => method))
+          else
+            ::Resque.enqueue(Resque::Performer, resource_key, id, method)
+            nil # not much use in holding on to state if we can't track it
+          end
+        end
+        JobManager.add(job) unless job.blank?
+      end
+      
+      private
+      def delayed_job?
+        defined? ::Delayed::Job
+      end
+
+      def resque?
+        defined? ::Resque
+      end
+      
+      def resque_with_status?
+        defined? ::Resque::Status
+      end
+    end
+  end
+end

data/lib/governor_background/job_manager.rb

@@ -0,0 +1,22 @@
+module GovernorBackground
+  class JobManager
+    @@finished_statuses = %w(completed failed killed).freeze
+    cattr_reader :jobs
+    class << self
+      @@jobs = []
+      def add(job)
+        @@jobs << job
+      end
+      
+      def clean(time = 1.day.ago)
+        @@jobs.reject!{|j| j.created_at < time}
+      end
+      
+      def finished_jobs
+        finished_jobs = @@jobs.select{|j| @@finished_statuses.include? j.status }
+        @@jobs -= finished_jobs
+        return finished_jobs
+      end
+    end
+  end
+end

data/lib/governor_background/rails.rb

@@ -0,0 +1,8 @@
+module GovernorBackground
+  # Standard <code>Rails::Engine</code>.
+  class Engine < ::Rails::Engine
+    config.to_prepare do
+      ApplicationController.helper(GovernorBackgroundHelper)
+    end
+  end
+end

data/lib/governor_background/resque/job.rb

@@ -0,0 +1,51 @@
+module Governor
+  module Resque
+    class Job
+      attr_reader :resource, :method_name, :created_at
+      def initialize(resource, method_name, job_id)
+        @resource = resource
+        @method_name = method_name
+        @id = job_id
+        @created_at = Time.now
+      end
+      
+      def status
+        # if we can't find it, assume it's been killed (not really sure if this is the proper assumption)
+        (job = resque_status) ? job.status : 'killed'
+      end
+      
+      def queued?
+        proxy :queued?
+      end
+      
+      def working?
+        proxy :working?
+      end
+      
+      def completed?
+        proxy :completed?
+      end
+      
+      def failed?
+        proxy :failed?
+      end
+      
+      def killed?
+        proxy :killed?
+      end
+      
+      def message
+        proxy :message, ''
+      end
+      
+      private
+      def resque_status
+        Resque::Status.get(@id)
+      end
+      
+      def proxy(method, default=false)
+        resque_status.try(method) or default
+      end
+    end
+  end
+end

data/lib/governor_background/resque/performer.rb

@@ -0,0 +1,12 @@
+module GovernorBackground
+  module Resque
+    class Performer
+      @queue = :governor
+
+      def self.perform(resource, id, method_name)
+        article = Governor.resources[resource].to.find(id)
+        article.send(method_name)
+      end
+    end
+  end
+end

data/lib/governor_background/resque/performer_with_state.rb

@@ -0,0 +1,17 @@
+module GovernorBackground
+  module Resque
+    class PerformerWithState < ::Resque::JobWithStatus
+      def self.queue
+        :governor
+      end
+      
+      def perform
+        resource = options['resource']
+        id = options['id']
+        method_name = options['method_name']
+        article = Governor.resources[resource].to.find(id)
+        article.send(method_name)
+      end
+    end
+  end
+end

data/lib/governor_background.rb

@@ -0,0 +1,22 @@
+require 'governor_background/rails'
+require 'governor_background/handler'
+require 'governor_background/job_manager'
+require 'governor_background/delayed/job'
+require 'governor_background/delayed/performer'
+require 'governor_background/resque/job'
+require 'governor_background/resque/performer'
+require 'governor_background/controllers/methods'
+
+background = Governor::Plugin.new('background')
+
+background.register_model_callback do |base|
+  module InstanceMethods
+    private
+    def run_in_background(method)
+      GovernorBackground::Handler.run_in_background self, method
+    end
+  end
+  base.send :include, InstanceMethods
+end
+
+Governor::PluginManager.register background

data/spec/governor_background/delayed/job_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+module GovernorBackground
+  module Delayed
+    describe Job do
+      let(:article) { Factory(:article, :author => Factory(:user)) }
+      it "has a status of queued if it's not currently locked" do
+        job = get_job_for stub(:id => article.id, :locked_at => nil)
+        job.should be_queued
+        job.status.should == 'queued'
+      end
+      
+      it "has a status of working if it's currently locked and being run and hasn't failed" do
+        job = get_job_for stub(:id => article.id, :run_at => Time.now, :locked_at => Time.now, :failed? => nil)
+        job.should be_working
+        job.status.should == 'working'
+      end
+      
+      it "has a status of completed if it can't be found" do
+        ::Delayed::Job.expects(:find_by_id).with(article.id).at_least_once.returns nil
+        job = Job.new(article, :post, stub(:id => article.id))
+        job.should be_completed
+        job.status.should == 'completed'
+      end
+      
+      it "has a status of failed if it's marked as failed and has been run as many times as possible" do
+        job = get_job_for stub(:id => article.id, :run_at => Time.now, :locked_at => Time.now, :failed? => Time.now, :attempts => ::Delayed::Worker.max_attempts)
+        job.should be_failed
+        job.status.should == 'failed'
+      end
+      
+      it "parses the message from DelayedJob" do
+        error_msg = "{DelayedJob error messages can be on
+        multiple lines"
+        job = get_job_for stub(:id => article.id, :run_at => Time.now, :locked_at => Time.now,
+          :failed? => Time.now, :attempts => ::Delayed::Worker.max_attempts, :last_error => error_msg)
+        job.message.should == "DelayedJob error messages can be on"
+      end
+      
+      private
+      def get_job_for(delayed_job)
+        ::Delayed::Job.expects(:find_by_id).with(delayed_job.id).at_least_once.returns delayed_job
+        Job.new(article, :post, delayed_job)
+      end
+    end
+  end
+end

data/spec/governor_background/handler_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+module GovernorBackground
+  class Handler
+    cattr_writer :use_resque # programmatically prefer resque
+    @@use_redis = false
+    class << self
+      private
+      def delayed_job?
+        defined?(::Delayed::Job) && !@@use_resque
+      end
+    end
+  end
+  
+  module Resque
+    class Job
+      attr_reader :resource, :method_name, :id, :created_at # make ID accessible for testing
+      def initialize(resource, method_name, job_id)
+        @resource = resource
+        @method_name = method_name
+        @id = job_id
+        @created_at = Time.now
+      end
+    end
+  end
+  
+  describe Handler do
+    before do
+      JobManager.jobs.clear
+      @article = Factory(:article, :author => Factory(:user))
+    end
+    
+    it "adds delayed jobs successfully" do
+      expect {
+        Handler.run_in_background(@article, :post)
+      }.to change { ::Delayed::Job.count }.by 1
+    end
+    
+    it "adds resque jobs successfully" do
+      Handler.use_resque = true
+      Handler.run_in_background(@article, :post)
+      id = JobManager.jobs.first.id
+      Resque::PerformerWithState.should have_queued(id, {:resource => :articles, :id => @article.id, :method_name => :post}).in(:governor)
+    end
+  end
+end

data/spec/governor_background/job_manager_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+module GovernorBackground
+  describe JobManager do
+    before(:each) do
+      JobManager.jobs.clear
+    end
+    it "keeps track of jobs" do
+      job = mock()
+      JobManager.add(job)
+      JobManager.jobs.size.should == 1
+    end
+    
+    it "can remove old jobs" do
+      JobManager.add(mock(:created_at => 2.days.ago))
+      JobManager.add(mock(:created_at => 3.hours.ago))
+      JobManager.add(mock(:created_at => Time.now))
+      JobManager.jobs.size.should == 3
+      JobManager.clean
+      JobManager.jobs.size.should == 2
+    end
+    
+    it "can remove old jobs specified by time" do
+      JobManager.add(mock(:created_at => 2.days.ago))
+      JobManager.add(mock(:created_at => 3.hours.ago))
+      JobManager.add(mock(:created_at => Time.now))
+      JobManager.jobs.size.should == 3
+      JobManager.clean(2.hours.ago)
+      JobManager.jobs.size.should == 1
+    end
+    
+    it "will return all finished jobs and remove them from the list" do
+      JobManager.add(queued    = mock('queued',    :status => 'queued'))
+      JobManager.add(working   = mock('working',   :status => 'working'))
+      JobManager.add(completed = mock('completed', :status => 'completed'))
+      JobManager.add(failed    = mock('failed',    :status => 'failed'))
+      JobManager.add(killed    = mock('killed',    :status => 'killed'))
+      
+      JobManager.jobs.size.should == 5
+      JobManager.finished_jobs.should == [completed, failed, killed]
+      JobManager.jobs.size.should == 2
+    end
+  end
+end

data/spec/governor_background/resque/performer_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+module GovernorBackground
+  module Resque
+    describe Performer do
+      before do
+        ResqueSpec.reset!
+        @article = Factory(:article, :author => Factory(:user))
+        ::Resque.enqueue(Performer, :articles, @article.id, :post)
+      end
+  
+      it "adds article.post to the :governor queue" do
+        Performer.should have_queued(:articles, @article.id, :post).in(:governor)
+      end
+    end
+  end
+end

data/spec/governor_background/resque/performer_with_state_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require File.expand_path('../../../../lib/governor_background/resque/performer_with_state',  __FILE__)
+
+module GovernorBackground
+  module Resque
+    describe PerformerWithState do
+      before do
+        ResqueSpec.reset!
+        @article = Factory(:article, :author => Factory(:user))
+        @id = PerformerWithState.create(:resource => :articles, :id => @article.id, :method => :post)
+      end
+  
+      it "adds article.post to the :governor queue" do
+        PerformerWithState.should have_queued(@id, {:resource => :articles, :id => @article.id, :method => :post}).in(:governor)
+      end
+    end
+  end
+end

data/spec/governor_background_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe GovernorBackground do
+  it "adds #run_in_background to Article" do
+    Article.private_instance_methods.include? 'run_in_background'
+  end
+end

data/spec/rails_app/.gitignore

@@ -0,0 +1,4 @@
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/

data/spec/rails_app/Gemfile

@@ -0,0 +1,43 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.0.5'
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3'
+
+gem 'devise'
+gem 'delayed_job'
+gem 'resque', :require => 'resque/server'
+gem 'resque-status', :require => 'resque/status'
+
+gem 'governor'
+gem 'governor_background', :path => '../..'
+
+gem 'dynamic_form'
+
+gem 'will_paginate', '~> 3.0.beta'
+
+# Use unicorn as the web server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19', :require => 'ruby-debug'
+
+# Bundle the extra gems:
+# gem 'bj'
+# gem 'nokogiri'
+# gem 'sqlite3-ruby', :require => 'sqlite3'
+# gem 'aws-s3', :require => 'aws/s3'
+
+# Bundle gems for the local environment. Make sure to
+# put test-only gems in this group so their generators
+# and rake tasks are available in development mode:
+# group :development, :test do
+#   gem 'webrat'
+# end

data/spec/rails_app/Gemfile.lock

@@ -0,0 +1,128 @@
+PATH
+  remote: ../..
+  specs:
+    governor_background (0.0.0)
+      governor
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.5)
+      actionpack (= 3.0.5)
+      mail (~> 2.2.15)
+    actionpack (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+    activesupport (3.0.5)
+    arel (2.0.9)
+    bcrypt-ruby (2.1.4)
+    builder (2.1.2)
+    daemons (1.1.2)
+    delayed_job (2.1.4)
+      activesupport (~> 3.0)
+      daemons
+    devise (1.3.1)
+      bcrypt-ruby (~> 2.1.2)
+      orm_adapter (~> 0.0.3)
+      warden (~> 1.0.3)
+    dynamic_form (1.1.4)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    governor (0.3.0)
+      rails (~> 3.0.5)
+    i18n (0.5.0)
+    json (1.4.6)
+    macaddr (1.0.0)
+    mail (2.2.17)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    orm_adapter (0.0.4)
+    polyglot (0.3.1)
+    rack (1.2.2)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.5)
+      actionmailer (= 3.0.5)
+      actionpack (= 3.0.5)
+      activerecord (= 3.0.5)
+      activeresource (= 3.0.5)
+      activesupport (= 3.0.5)
+      bundler (~> 1.0)
+      railties (= 3.0.5)
+    railties (3.0.5)
+      actionpack (= 3.0.5)
+      activesupport (= 3.0.5)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    redis (2.2.0)
+    redis-namespace (0.10.0)
+      redis (< 3.0.0)
+    redisk (0.2.2)
+      redis (>= 0.1.1)
+      redis-namespace (>= 0.1.0)
+    resque (1.15.0)
+      json (~> 1.4.6)
+      redis-namespace (>= 0.10.0)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    resque-status (0.2.3)
+      redisk (>= 0.2.1)
+      resque (>= 1.3.1)
+      uuid (>= 2.0.2)
+    sinatra (1.2.3)
+      rack (~> 1.1)
+      tilt (>= 1.2.2, < 2.0)
+    sqlite3 (1.3.3)
+    thor (0.14.6)
+    tilt (1.2.2)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.26)
+    uuid (2.3.2)
+      macaddr (~> 1.0)
+    vegas (0.1.8)
+      rack (>= 1.0.0)
+    warden (1.0.3)
+      rack (>= 1.0.0)
+    will_paginate (3.0.pre2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  delayed_job
+  devise
+  dynamic_form
+  governor
+  governor_background!
+  rails (= 3.0.5)
+  resque
+  resque-status
+  sqlite3
+  will_paginate (~> 3.0.beta)