couch_loafer 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Adam Groves
+
+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,7 @@
+couch_loafer===========
+Description goes here.
+
+COPYRIGHT
+=========
+
+Copyright (c) 2008 Adam Groves. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rake'
+require File.join(File.expand_path(File.dirname(__FILE__)),'lib','couch_loafer')
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "couch_loafer"
+    s.date = "2009-01-22"
+    s.summary = %Q{Foo}
+    s.email = "adam.groves@gmail.com"
+    s.homepage = "http://github.com/addywaddy/couch_loafer"
+    s.description = "Bar"
+    s.has_rdoc = true
+    s.authors = ["Adam Groves"]
+    s.files = %w( LICENSE README.md Rakefile ) + Dir["{lib,spec}/**/*"]
+    s.extra_rdoc_files = %w( README.md LICENSE )
+    s.require_path = "lib"
+    s.add_dependency("couch_surfer", ">= 0.1.0")
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'couch_loafer'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs << 'lib' << 'spec'
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |t|
+  t.libs << 'lib' << 'spec'
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+end
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+rescue LoadError
+  puts "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+end
+
+task :default => :spec

data/lib/couch_loafer.rb

@@ -0,0 +1,11 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems'
+require 'extlib'
+require 'couch_surfer'
+
+module CouchLoafer
+  autoload :Job,        'couch_loafer/job'
+  autoload :Worker,        'couch_loafer/worker'
+end

data/lib/couch_loafer/job.rb

@@ -0,0 +1,102 @@
+require 'couch_surfer'
+
+module CouchLoafer
+  class Job
+    include CouchSurfer::Model
+    
+    cattr_accessor :worker_name
+    cattr_accessor :keep_in_foreground
+
+    self.worker_name = "host:#{Socket.gethostname} pid:#{Process.pid}" rescue "pid:#{Process.pid}"
+    
+    key_accessor :method_name, :instance_id, :class_name, :priority, :attempts, :owner, :failed_at, :exception, :arguments
+    
+    set_default({
+      :priority => 0,
+      :attempts => 0
+    })
+    
+    timestamps!
+    
+    cast :failed_at, :as => 'Time'
+    
+    view_by :importance,
+      :map => 
+        "function(doc) {
+          if ((doc['couchrest-type'] == 'CouchLoafer::Job')) {
+            time = - parseInt(doc.created_at.replace(/\\D/g, ''));
+            emit([doc.priority, time], null);
+          }
+        }"
+
+    view_by :failed_at
+    class << self
+
+      def foreground?
+        @@keep_in_foreground
+      end
+
+      def add(*args)
+        instance = args.first
+        options = extract_options!(args)
+        case instance
+        when CouchSurfer::Model
+          if foreground?
+            instance.send(options[:method])
+          else
+            create_instance_job(options.merge(:class_name => instance.class.name, :instance_id => instance.id))
+          end
+        end
+      end
+      
+      def available
+        by_importance(:limit => 5)
+      end
+      
+      def work_off
+        available.each do |job|
+          job.lock!(worker_name)
+          job.execute!
+        end
+      end
+      
+      def retrieve(id)
+        get(id)
+        rescue RestClient::ResourceNotFound
+          nil
+      end
+      
+      private
+      
+      def create_instance_job(options)
+        options.merge!(:method_name => options[:method].to_s)
+        options.delete(:method)
+        create(options)
+      end
+      
+      def extract_options!(args)
+        args.last.is_a?(Hash) ? args.pop : {}
+      end
+    end
+    
+    def lock!(worker_name)
+      update_attributes(:owner => worker_name)
+    end
+    
+    def fail!(e)
+      update_attributes(:failed_at => Time.now, :owner => nil, :exception => {:message => e.message, :backtrace => e.backtrace})
+    end
+    
+    def execute!
+      instance = ::Extlib::Inflection.constantize(class_name).get(instance_id)
+      if arguments
+        instance.send(method_name, *arguments)
+      else
+        instance.send(method_name)
+      end
+      destroy
+    rescue StandardError => e
+      fail!(e)
+    end
+  end
+end

data/lib/couch_loafer/worker.rb

@@ -0,0 +1,32 @@
+module CouchLoafer
+  class Worker
+    SLEEP = 5
+
+    cattr_accessor :logger
+    self.logger = if defined?(Merb::Logger)
+      Merb.logger
+    elsif defined?(RAILS_DEFAULT_LOGGER)
+      RAILS_DEFAULT_LOGGER
+    end
+
+    def start
+      trap('TERM') { say 'Exiting...'; $exit = true }
+      trap('INT')  { say 'Exiting...'; $exit = true }
+      loop do
+        single_run
+        break if $exit
+        sleep(SLEEP)
+      end
+    end
+    
+    def single_run
+      CouchLoafer::Job.work_off
+    end
+
+    def say(text)
+      puts text unless @quiet
+      logger.info text if logger
+    end
+
+  end
+end

data/spec/couch_loafer/job_spec.rb

@@ -0,0 +1,133 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe CouchLoafer::Job do
+  class Model
+    def do_something
+      "OK"
+    end
+  end
+  describe "when adding an instance job" do
+    before(:all) do
+      @dispatch = Dispatch.create()
+      @job = CouchLoafer::Job.add(@dispatch, :method => :prepare_archive)
+    end
+    it "should serialize the method name" do
+      @job.method_name.should == "prepare_archive"
+    end
+    
+    it "should serialize the instance's ID" do
+      @job.instance_id.should == @dispatch.id
+    end
+    
+    it "should specify the instance's class name" do
+      @job.class_name.should == "Dispatch"
+    end
+    
+    it "should have timestamps" do
+      @job.created_at.should == Time.parse(@job['created_at'])
+      @job.updated_at.should == Time.parse(@job['updated_at'])
+    end
+    
+    it "should have an initial priority" do
+      @job.priority.should == 0
+    end
+    
+    it "should have an initial number of attempts" do
+      @job.attempts.should == 0
+    end
+    
+    it "should start off without an owner" do
+      @job.owner.should be_nil
+    end
+  end
+  
+  describe "when adding an instance job with arguments" do
+    before(:all) do
+      @dispatch = Dispatch.create()
+      @job = CouchLoafer::Job.add(@dispatch, :method => :update_values, :arguments => ["foo", 1])
+    end
+    
+    it "should serialie the arguments" do
+      @job.arguments.should == ["foo", 1]
+    end
+  end
+  
+  describe "when listing the most important jobs" do
+    before(:all) do
+      reset_db!
+      dispatch = Dispatch.create()
+      10.times do |i|
+        CouchLoafer::Job.add(dispatch, :method => :prepare_archive, :priority => 10-i)
+      end
+      sleep(1)
+      CouchLoafer::Job.add(dispatch, :method => :prepare_archive, :priority => 5)
+      @most_important = CouchLoafer::Job.add(dispatch, :method => :prepare_archive)
+    end
+    
+    it "should return the top five jobs" do
+      CouchLoafer::Job.available.size.should == 5
+    end
+    it "should have the most important job first" do
+      CouchLoafer::Job.available.first.should == @most_important
+    end
+  end
+  
+  describe "when running a job" do
+    before(:each) do
+      @dispatch = Dispatch.create()
+      @job = CouchLoafer::Job.add(@dispatch, :method => :prepare_archive)
+      @bad_job = CouchLoafer::Job.add(@dispatch, :method => :non_existant_method)
+    end
+    it "should execute the method on the model instance" do
+      @job.execute!
+      Dispatch.get(@dispatch.id).archived.should be_true
+    end
+    
+    it "should mark it as failed, unlock it and log the errors if an Exception occurs" do
+      @bad_job.execute!
+      reloaded_bad_job = CouchLoafer::Job.get(@bad_job.id)
+      reloaded_bad_job.failed_at.should be_kind_of(Time)
+      reloaded_bad_job.exception['message'].should match(/undefined method/)
+      reloaded_bad_job.owner.should be_nil
+    end
+  end
+  
+  describe "when running a job with arguments" do
+    before(:each) do
+      @dispatch = Dispatch.create()
+      @job = CouchLoafer::Job.add(@dispatch, :method => :update_values, :arguments => ["foo", 1])
+    end
+    it "should execute the method on the model instance" do
+      @job.execute!
+      Dispatch.get(@dispatch.id).value1.should == "foo"
+      Dispatch.get(@dispatch.id).value2.should == 1
+    end
+  end
+  
+  describe "when retrieving a job" do
+    before(:each) do
+      @dispatch = Dispatch.create()
+      @job = CouchLoafer::Job.add(@dispatch, :method => :update_values, :arguments => ["foo", 1])
+    end
+    it "should retrieve the if it exists" do
+      CouchLoafer::Job.retrieve(@job.id).id.should == @job.id
+    end
+    
+    it "should return nil if the job doesn't exist" do
+      CouchLoafer::Job.get(@job.id).send(:execute!)
+      CouchLoafer::Job.retrieve(@job.id).should be_nil
+    end
+  end
+
+  describe "keeping a job in the foreground" do
+    after(:each) do
+      CouchLoafer::Job.keep_in_foreground = false
+    end
+
+    it "should do that" do
+      CouchLoafer::Job.keep_in_foreground = true
+      thing = Dispatch.create()
+      CouchLoafer::Job.add(thing, :method => :do_something).should == "OK"
+    end
+  end
+end

data/spec/couch_loafer/worker_spec.rb

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe CouchLoafer::Worker do
+  describe "when started" do
+    before(:all) do
+      reset_db!
+      9.times do |i|
+        dispatch = Dispatch.create()
+        CouchLoafer::Job.add(dispatch, :method => :prepare_archive)
+      end
+      CouchLoafer::Job.add(Dispatch.create, :method => :no_method)
+      CouchLoafer::Worker.new.single_run
+    end
+    it "should delete the jobs once executed" do
+      CouchLoafer::Job.all.size.should == 6
+    end
+    
+    it "should mark one job as having failed" do
+      CouchLoafer::Job.by_failed_at.size.should == 1
+    end
+    
+    it "should carry out the work" do
+      Dispatch.by_archived.size.should == 4
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'couch_loafer'
+
+COUCHHOST = "http://127.0.0.1:5984"
+TESTDB = 'couch_loafer-test'
+def reset_db!
+  cr = CouchRest.new(COUCHHOST)
+  db = cr.database(TESTDB)
+  db.delete! rescue nil
+  CouchSurfer::Model.default_database = CouchRest.database!("#{COUCHHOST}/#{TESTDB}")
+end
+
+class Dispatch
+  include CouchSurfer::Model
+  key_accessor :archived, :value1, :value2
+
+  view_by :archived
+
+  def prepare_archive
+    update_attributes(:archived => true)
+  end
+
+  def update_values(v1, v2)
+    update_attributes(:value1 => v1, :value2 => v2)
+  end
+
+  def do_something
+    "OK"
+  end
+end
+
+Spec::Runner.configure do |config|
+  require 'couch_surfer'
+  require 'couchrest'
+  reset_db!
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: couch_loafer
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Adam Groves
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-12 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: couch_surfer
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.2
+    version: 
+description: Bar
+email: adam.groves@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- lib/couch_loafer.rb
+- lib/couch_loafer/job.rb
+- lib/couch_loafer/worker.rb
+- spec/couch_loafer/job_spec.rb
+- spec/couch_loafer/worker_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/addywaddy/couch_loafer
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: Foo
+test_files: 
+- spec/couch_loafer/job_spec.rb
+- spec/couch_loafer/worker_spec.rb
+- spec/spec_helper.rb