relaxed-job 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 David Dollar
+
+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.rdoc

@@ -0,0 +1,16 @@
+= relaxed-job
+
+Relaxed Job
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with Rakefile or VERSION.
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 David Dollar. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+require 'relaxed_job/tasks'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "relaxed-job"
+    gem.summary = %Q{Relaxed Job}
+    gem.description = gem.summary
+    gem.email = "<ddollar@gmail.com>"
+    gem.homepage = "http://github.com/ddollar/relaxed-job"
+    gem.authors = ["David Dollar"]
+
+    gem.add_development_dependency "rspec"
+
+    gem.add_dependency "couchrest"
+    gem.add_dependency "libdir"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "relaxed-job #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/relaxed-job.rb

@@ -0,0 +1 @@
+require 'relaxed_job'

data/lib/relaxed_job.rb

@@ -0,0 +1,12 @@
+module RelaxedJob
+
+  def self.couchdb(url)
+    database = CouchRest.database!(url)
+    database.update_designs(File.join(File.dirname(__FILE__), 'relaxed_job', 'designs'))
+    database
+  end
+
+end
+
+require 'relaxed_job/queue'
+require 'relaxed_job/worker'

data/lib/relaxed_job/designs/jobs/views/completed/map.js

@@ -0,0 +1,5 @@
+function(doc) {
+  if (doc.class == 'job' && doc.state == 'complete') {
+    emit(doc.completed_at, doc);
+  }
+}

data/lib/relaxed_job/designs/jobs/views/errored/map.js

@@ -0,0 +1,5 @@
+function(doc) {
+  if (doc.class == 'job' && doc.state == 'error') {
+    emit(doc.errored_at, doc);
+  }
+}

data/lib/relaxed_job/designs/jobs/views/locked/map.js

@@ -0,0 +1,5 @@
+function(doc) {
+  if (doc.class == 'job' && doc.state == 'locked') {
+    emit(doc.locked_by, doc);
+  }
+}

data/lib/relaxed_job/designs/jobs/views/pending/map.js

@@ -0,0 +1,5 @@
+function(doc) {
+  if (doc.class == 'job' && doc.state == 'pending') {
+    emit(doc.queued_at, doc);
+  }
+}

data/lib/relaxed_job/queue.rb

@@ -0,0 +1,106 @@
+require 'couchrest'
+
+class RelaxedJob::Queue
+
+  attr_reader :couchdb_url
+  attr_reader :options
+
+  def initialize(couchdb_url)
+    @couchdb_url = couchdb_url
+    @options = options
+  end
+
+  def enqueue(object)
+    enqueue_with_method object, :perform
+  end
+
+  def enqueue_with_method(object, method, *args)
+    couchdb.save_doc({
+      'class'     => 'job',
+      'state'     => 'pending',
+      'method'    => method.to_s,
+      'arguments' => args.to_a,
+      'object'    => Marshal.dump(object),
+      'queued_at' => Time.now.utc
+    })
+  end
+
+  def lock(count)
+    pending_jobs(count).each do |job|
+      job['state']     = 'locked'
+      job['locked_by'] = worker_name
+      couchdb.save_doc(job)
+    end
+  end
+
+  def clear_locks!
+    locked_jobs.each do |job|
+      job['state'] = 'pending'
+      job.delete('locked_by')
+      couchdb.save_doc(job)
+    end
+  end
+
+  def work(worker_name=worker_name)
+    lock 3
+
+    counts = { :complete => 0, :error => 0 }
+
+    locked_jobs.each do |job|
+      begin
+        object = Marshal.load(job['object'])
+        object.send(job['method'], *(job['arguments']))
+
+        counts[:complete] += 1
+
+        job['state']        = 'complete'
+        job['completed_at'] = Time.now.utc
+        couchdb.save_doc(job)
+      rescue StandardError => ex
+        counts[:error] += 1
+
+        job['state']      = 'error'
+        job['exception']  = Marshal.dump(ex)
+        job['errored_at'] = Time.now.utc
+        couchdb.save_doc(job)
+      end
+    end
+
+    counts
+  end
+
+  def worker_name
+    "host:#{Socket.gethostname} pid:#{$$}"
+  rescue
+    "pid:#{$$}"
+  end
+
+## job types #################################################################
+
+  def completed_jobs
+    jobs_by_type(:completed)
+  end
+
+  def errored_jobs
+    jobs_by_type(:errored)
+  end
+
+  def locked_jobs
+    jobs_by_type(:locked, :key => worker_name)
+  end
+
+  def pending_jobs(count)
+    jobs_by_type(:pending, :limit => count)
+  end
+
+private ######################################################################
+
+  def couchdb
+    @couchdb ||= RelaxedJob.couchdb(couchdb_url)
+  end
+
+  def jobs_by_type(type, options={})
+    couchdb.view("jobs/#{type}", options)['rows'].map { |row| row['value'] }
+  end
+
+end

data/lib/relaxed_job/tasks.rb

@@ -0,0 +1,19 @@
+require 'relaxed_job/worker'
+
+def relaxed_job_url
+  ENV['RELAXED_JOB_COUCHDB_URL'] || 'http://localhost:5984/relaxed_job'
+end
+
+namespace :jobs do
+
+  desc "Run job daemon"
+  task :work do
+    RelaxedJob::Worker.new(relaxed_job_url).start
+  end
+
+  task :test do
+    queue = RelaxedJob::Queue.new(relaxed_job_url)
+    queue.enqueue_with_method("", :to_s)
+  end
+
+end

data/lib/relaxed_job/worker.rb

@@ -0,0 +1,62 @@
+require 'benchmark'
+require 'couchrest'
+require 'relaxed_job'
+
+class RelaxedJob::Worker
+
+  SLEEP = 5
+
+  attr_reader :queue
+  attr_reader :options
+
+  def initialize(couchrest_url, options={})
+    @queue   = RelaxedJob::Queue.new(couchrest_url)
+    @options = options
+  end
+
+  def name
+    "testname"
+  end
+
+  def start
+    say "*** Starting job worker #{queue.worker_name}"
+
+    trap('TERM') { say 'Exiting...'; $exit = true }
+    trap('INT')  { say 'Exiting...'; $exit = true }
+
+    loop do
+      result = nil
+
+      realtime = Benchmark.realtime do
+        result = queue.work
+        sleep 1
+      end
+
+      count = result.values.inject(0) { |a,v| a+v }
+
+      break if $exit
+
+      if count.zero?
+        sleep(SLEEP)
+      else
+        say "#{count} jobs processed at %.4f j/s, %d failed ..." % [count / realtime, result[:error]]
+      end
+
+      break if $exit
+    end
+
+  ensure
+    queue.clear_locks!
+  end
+
+  def say(text)
+    puts text unless options[:quiet]
+  end
+
+private ######################################################################
+
+  def quiet
+    options[:quiet]
+  end
+
+end

data/relaxed-job.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{relaxed-job}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["David Dollar"]
+  s.date = %q{2009-11-09}
+  s.description = %q{Relaxed Job}
+  s.email = %q{<ddollar@gmail.com>}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/relaxed-job.rb",
+     "lib/relaxed_job.rb",
+     "lib/relaxed_job/designs/jobs/views/completed/map.js",
+     "lib/relaxed_job/designs/jobs/views/errored/map.js",
+     "lib/relaxed_job/designs/jobs/views/locked/map.js",
+     "lib/relaxed_job/designs/jobs/views/pending/map.js",
+     "lib/relaxed_job/queue.rb",
+     "lib/relaxed_job/tasks.rb",
+     "lib/relaxed_job/worker.rb",
+     "relaxed-job.gemspec",
+     "spec/rcov.opts",
+     "spec/relaxed_job/queue_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/ddollar/relaxed-job}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Relaxed Job}
+  s.test_files = [
+    "spec/relaxed_job/queue_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_runtime_dependency(%q<couchrest>, [">= 0"])
+      s.add_runtime_dependency(%q<libdir>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<couchrest>, [">= 0"])
+      s.add_dependency(%q<libdir>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<couchrest>, [">= 0"])
+    s.add_dependency(%q<libdir>, [">= 0"])
+  end
+end

data/spec/rcov.opts

@@ -0,0 +1,2 @@
+--exclude "spec/*,gems/*"
+--rails

data/spec/relaxed_job/queue_spec.rb

@@ -0,0 +1,81 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "RelaxedJob::Queue" do
+
+  before(:each) do
+    @queue    = test_delayed_job_queue
+    @enqueued = TestFileWriter.new
+  end
+
+  after(:all) do
+    couchdb_cleanup
+  end
+
+  describe "using enqueue to queue a class" do
+    before(:each) do
+      @queue.enqueue @enqueued
+      @results = @queue.work
+    end
+
+    it "has the right data in the file" do
+      File.read(@enqueued.filename).should == 'perform'
+    end
+
+    it "returns the count of jobs" do
+      @results.should == { :complete => 1, :error => 0 }
+    end
+  end
+
+  describe "using enqueue_with_method to call a different method" do
+    before(:each) do
+      @queue.enqueue_with_method @enqueued, :perform_two
+      @queue.work
+    end
+
+    it "has the right data in the file" do
+      File.read(@enqueued.filename).should == 'perform_two'
+    end
+  end
+
+  describe "using enqueue_with_method to call a method with arguments" do
+    before(:each) do
+      @queue.enqueue_with_method @enqueued, :perform_args, 'one', 'two'
+      @queue.work
+    end
+
+    it "has the right data in the file" do
+      File.read(@enqueued.filename).should == '["one", "two"]'
+    end
+  end
+
+  describe "with an erroring method" do
+    before(:each) do
+      @queue.enqueue_with_method @enqueued, :perform_with_error, 'ErrorText'
+      @results = @queue.work
+    end
+
+    it "stores the errored job with its exception" do
+      job = @queue.errored_jobs.last
+      exception = Marshal.load(job['exception'])
+      exception.message.should == 'ErrorText'
+    end
+
+    it "returns the count of jobs" do
+      @results.should == { :complete => 0, :error => 1 }
+    end
+  end
+
+  describe "with locked jobs" do
+    before(:each) do
+      @queue.enqueue_with_method @enqueued, :perform_with_error, 'ErrorText'
+      @queue.lock(1)
+    end
+    
+    it "should be able to unlock jobs" do
+      @queue.locked_jobs.length.should == 1
+      @queue.clear_locks!
+      @queue.locked_jobs.length.should == 0
+    end
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'couchrest'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'relaxed-job'
+require 'spec'
+require 'spec/autorun'
+
+TEST_RELAXED_JOB_COUCH_URL = 'http://localhost:5984/relaxed_job_test'
+
+class TestFileWriter
+  attr_reader :filename
+
+  def initialize
+    @filename = "/tmp/relaxed_job_test/#{rand(1000000)}.file"
+  end
+
+  def perform
+    write_to_file('perform')
+  end
+
+  def perform_two
+    write_to_file('perform_two')
+  end
+
+  def perform_args(*args)
+    write_to_file(args.inspect)
+  end
+
+  def perform_with_error(message)
+    raise message
+  end
+
+  def write_to_file(data)
+    File.open(filename, 'w') do |file|
+      file.print data
+    end
+  end
+end
+
+def test_delayed_job_queue
+  RelaxedJob::Queue.new(TEST_RELAXED_JOB_COUCH_URL)
+end
+
+def couchdb_cleanup
+  CouchRest.database(TEST_RELAXED_JOB_COUCH_URL).delete!
+end
+
+Spec::Runner.configure do |config|
+  config.before(:all) do
+    FileUtils.mkdir_p('/tmp/relaxed_job_test')
+  end
+
+  config.after(:all) do
+    FileUtils.rm_rf('/tmp/relaxed_job_test')
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: relaxed-job
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- David Dollar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-09 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: couchrest
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: libdir
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Relaxed Job
+email: <ddollar@gmail.com>
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/relaxed-job.rb
+- lib/relaxed_job.rb
+- lib/relaxed_job/designs/jobs/views/completed/map.js
+- lib/relaxed_job/designs/jobs/views/errored/map.js
+- lib/relaxed_job/designs/jobs/views/locked/map.js
+- lib/relaxed_job/designs/jobs/views/pending/map.js
+- lib/relaxed_job/queue.rb
+- lib/relaxed_job/tasks.rb
+- lib/relaxed_job/worker.rb
+- relaxed-job.gemspec
+- spec/rcov.opts
+- spec/relaxed_job/queue_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/ddollar/relaxed-job
+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.5
+signing_key: 
+specification_version: 3
+summary: Relaxed Job
+test_files: 
+- spec/relaxed_job/queue_spec.rb
+- spec/spec_helper.rb