kthxbye 1.0.0

data/test/test_kthxbye.rb

@@ -0,0 +1,213 @@
+require 'test_helper'
+
+class TestKthxbye < Test::Unit::TestCase
+  context "See Kthxbye Configuration" do
+
+    should "configure an app with given params" do
+      k = Kthxbye::Config.setup(:redis_server => "localhost", :redis_port => 8080, :verbose => true)
+
+      assert_equal 'localhost', Kthxbye::Config.options[:redis_server] 
+      assert_equal 8080, Kthxbye::Config.options[:redis_port]
+      assert_equal true, Kthxbye::Config.options[:verbose]
+    end
+
+    should "configure an app with default params" do
+      Kthxbye::Config.setup
+
+      assert_equal '127.0.0.1', Kthxbye::Config.options[:redis_server] 
+      assert_equal 9876, Kthxbye::Config.options[:redis_port]
+      assert_equal false, Kthxbye::Config.options[:verbose]
+    end
+
+  end
+
+  context "See Kthxbye" do
+    setup do
+      Kthxbye::Config.setup
+      Kthxbye.redis.flushall
+    end
+
+    should "register unregister and delete queues" do
+      assert_equal 0, Kthxbye.queues.size
+
+      assert Kthxbye.register_queue "dogs"
+      assert Kthxbye.register_queue "cats"
+      
+      assert_equal 2, Kthxbye.queues.size
+      assert_equal ["cats", "dogs"], Kthxbye.queues
+
+      assert Kthxbye.unregister_queue("dogs")
+      assert_equal ["cats"], Kthxbye.queues
+
+      assert Kthxbye.delete_queue("cats")
+      assert_equal [], Kthxbye.queues
+    end
+
+    should "store a couple of jobs and return good ids" do
+      assert id = Kthxbye.enqueue("test", SimpleJob, {:hello => "world"}, "test params") 
+      assert id2 = Kthxbye.enqueue("test", GoodJob, "I am a sentence to print") 
+      assert_equal 1, id
+      assert_equal 2, id2
+    end
+
+    should "enqueue a job and show a queue size of one" do
+      assert_equal 0, Kthxbye.size("test") 
+      Kthxbye.enqueue("test", SimpleJob, {:hello => "world"}, "test params")
+      assert_equal 1, Kthxbye.size("test")
+    end
+
+    should "peek at the datastore for a specific job" do
+      id = Kthxbye.enqueue("test", SimpleJob, {:hello => "world"}, "test params")
+      assert_equal [{'hello' => "world"}, "test params"], Kthxbye.data_peek("test", id)['payload']
+    end
+
+    should "peek at all the data stores" do
+      Kthxbye.enqueue("test", SimpleJob, "first", "job")
+      Kthxbye.enqueue("test", SimpleJob, "second", "job")
+
+      assert_equal ({'1' => {'klass' => 'SimpleJob', 'payload' => ["first", "job"]}, 
+        '2' => {'klass' => 'SimpleJob', 'payload' => ["second", "job"]}}), Kthxbye.data_peek("test")
+    end
+    
+    should "peek at the resultstore for a specific job" do
+      id = Kthxbye.enqueue("test", GoodJob, "Jim")
+      worker = Kthxbye::Worker.new("test", 0)
+      worker.run
+
+      assert_equal "Good job, Jim", Kthxbye.result_peek("test", id)
+    end
+
+    should "peek at all the result stores" do
+      Kthxbye.enqueue("test", GoodJob, "Jim")
+      Kthxbye.enqueue("test", GoodJob, "Dwight")
+      worker = Kthxbye::Worker.new("test", 0)
+      worker.run
+
+      assert_equal ({'1' => "Good job, Jim", '2' =>  "Good job, Dwight"}), Kthxbye.result_peek("test") 
+    end
+
+    should "show its queues correctly" do
+      Kthxbye.enqueue("these-jobs", SimpleJob, {:hello => "world"}, "test params")
+      Kthxbye.enqueue("those-jobs", SimpleJob, {:hello => "world"}, "test params")
+
+      assert_equal ["these-jobs", "those-jobs"], Kthxbye.queues
+
+      Kthxbye.delete_queue("these-jobs")
+      assert_equal ["those-jobs"], Kthxbye.queues
+    end
+
+    should "grab a job off the queue" do  
+      Kthxbye.enqueue("these-jobs", SimpleJob, {:hello => "world"}, "test params")
+
+      assert job = Kthxbye.salvage("these-jobs")
+      assert_equal Kthxbye::Job, job.class
+      assert_equal 1, job.id
+      assert_equal "these-jobs", job.queue
+      assert_equal "SimpleJob", job.data['klass']
+    end
+
+    should "return a job" do
+      id = Kthxbye.enqueue( "test", SimpleJob, 1, 2 )
+      assert job = Kthxbye::Job.find( id, "test" )
+      assert_equal Kthxbye::Job, job.class
+      assert_equal [1, 2], job.data['payload']
+    end
+
+    should "perform a job" do
+      id = Kthxbye.enqueue( "test", GoodJob, "Lukas" )
+      job = Kthxbye::Job.find(id, "test")
+
+      assert result = job.perform
+      assert "Good job, Lukas!", result
+    end
+
+    should "retry a job if attempts setting is > 1" do
+      Kthxbye::Config.options[:attempts] = 2
+      id = Kthxbye.enqueue( "test", BadJob )
+      job = Kthxbye::Job.find(id, "test")
+
+      job.perform
+      assert_equal 2, job.instance_variable_get(:@failed_attempts)
+      
+    end
+
+    should "delete a job" do
+      id = Kthxbye.enqueue("test", SimpleJob, 1, 2 )
+      assert_equal :active, Kthxbye::Job.destroy(id, "test")
+      assert_equal nil, Kthxbye::Job.find(id, "test")
+    end
+
+    should "return all keys" do
+      Kthxbye.enqueue("test", SimpleJob, 1, 2 )
+      Kthxbye.register_queue("money")
+
+      assert_equal ["data-store:test", "queue:test", "queues", "uniq_id"], Kthxbye.keys.sort
+    end
+    
+    should "register and unregister workers" do
+      assert_equal [], Kthxbye.workers
+
+      worker = Kthxbye::Worker.new("bill")
+      worker.register_worker
+
+      assert_equal [worker], Kthxbye.workers
+
+      worker2 = Kthxbye::Worker.new("holiday")
+      worker2.register_worker
+
+      assert_equal [worker, worker2], Kthxbye.workers.sort
+
+      worker2.unregister_worker
+      assert_equal [worker], Kthxbye.workers
+
+      worker.unregister_worker
+      assert_equal [], Kthxbye.workers
+    end
+
+    should "show all active workers" do
+      worker = Kthxbye::Worker.new( "test" )
+      id = Kthxbye.enqueue( "test", SimpleJob, 1, 2 )
+      worker.register_worker
+      worker.working( Kthxbye::Job.find( id, "test" ) )
+
+      assert_equal [[worker, {'job_id' => id, 'started' => Time.now.to_s }]], Kthxbye.working
+    end
+
+    should "return the correct status of a job" do
+      worker1 = Kthxbye::Worker.new( "good", 0 )
+      worker2 = Kthxbye::Worker.new( "bad", 0 )
+
+      good_job = Kthxbye.enqueue( "good", GoodJob, "Dave" )
+      bad_job = Kthxbye.enqueue( "bad", BadJob )
+      job = Kthxbye::Job.find(good_job, "good")
+      
+      assert_equal :active, job.status
+      job.dequeue
+      assert_equal :inactive, job.status
+      job.rerun
+
+      worker1.run
+      assert_equal :succeeded, job.status
+
+      job = Kthxbye::Job.find(bad_job, "bad")
+      worker2.run
+
+      assert_equal :failed, job.status
+    end
+    
+    should "display nice inspect" do
+      i = Kthxbye.inspect
+
+      assert_equal Kthxbye::Version, i[:version]
+      assert_equal 0, i[:keys]
+      assert_equal 0, i[:workers]
+      assert_equal 0, i[:queues]
+      assert_equal 0, i[:working]
+      assert_equal 0, i[:pending]
+    end
+
+    
+
+  end
+end
+

data/test/test_worker.rb

@@ -0,0 +1,148 @@
+
+class TestWorker < Test::Unit::TestCase
+  context "See Kthxbye::Worker" do
+    setup do
+      Kthxbye::Config.setup(:verbose => false, :redis_port => 9876) 
+      Kthxbye.redis.flushall
+      
+      @id = Kthxbye.enqueue( "test", SimpleJob, 1, 2 )
+      @worker = Kthxbye::Worker.new("test", 0)
+    end
+
+    should "register and show a worker" do
+      @worker.run do
+        assert_equal [@worker], Kthxbye.workers
+      end
+    end
+
+    should "find a registered worker and its queues" do
+      @worker.run do
+        found = Kthxbye::Worker.find(@worker.id)
+        assert_equal @worker, found
+      end
+    end
+
+    should "startup a worker and register it as working" do
+      @worker.run do
+        assert_equal [[@worker.to_s, {'job_id' => @id, 'started' => Time.now.to_s}]], Kthxbye.working
+      end
+    end
+
+    should "pull jobs from given queue and run them" do
+      @worker.run
+      
+      assert_equal 0, Kthxbye.size("test")
+    end
+
+    should "store a job's results and retrieve them" do
+      id = Kthxbye.enqueue("new", GoodJob, "Lukas")
+      worker = Kthxbye::Worker.new("new", 0)
+      worker.run
+
+      assert_equal 1, Kthxbye.job_results("new").size
+      assert_equal "Good job, Lukas", Kthxbye.job_results("new", id)
+    end
+
+    should "capture and report failed jobs" do
+      id = Kthxbye.enqueue( "bad", BadJob )
+      id2 = Kthxbye.enqueue( "bad", BadJobWithSyntaxError )
+
+      assert_equal 0, Kthxbye::Failure.count
+
+      worker = Kthxbye::Worker.new("bad", 0 )
+      worker.run
+
+      assert_equal 2, Kthxbye::Failure.count
+      assert_equal "Bad job!", Kthxbye::Failure.find(id)["error"]
+      assert_equal "Extra Bad job!", Kthxbye::Failure.find(id2)["error"]
+
+      assert_equal ["Bad job!", "Extra Bad job!"], Kthxbye::Failure.all.map{|x| x['error']}
+
+      assert_equal 1, Kthxbye::Failure.count_type(RuntimeError)
+    end
+
+    should "report queues available to workers when added via csv (alphabetical)" do
+      worker = Kthxbye::Worker.new("good,bad,ugly")
+      assert_equal ["good", "bad", "ugly"].sort, worker.queues
+    end
+  
+    should "report queues available to workers when using * (alphabetical)" do
+      Kthxbye.register_queue("hello")
+      Kthxbye.register_queue("world")
+
+      worker = Kthxbye::Worker.new("*")
+      assert_equal ["hello", "test", "world"].sort, worker.queues
+    end
+
+    should "report queues available to worker when passed an array (alphabetical)" do
+      worker = Kthxbye::Worker.new(["one", "two", "three"])
+      assert_equal ["one", "two", "three"].sort, worker.queues
+    end
+
+    should "work jobs from multiple queues" do
+      Kthxbye.enqueue("other", GoodJob, "Boieee")
+      Kthxbye.enqueue("more", GoodJob, "Lukas")
+
+      worker = Kthxbye::Worker.new("*", 0)
+
+      worker.run
+
+      assert_equal 0, Kthxbye.size("test")
+      assert_equal 0, Kthxbye.size("other")
+      assert_equal 0, Kthxbye.size("more")
+    end
+    
+    should "return job active once working it" do
+      job = Kthxbye::Job.find(@id, "test")
+      
+      @worker.working(job)
+
+      assert @worker.working?
+      assert_equal @worker.current_job, job
+
+      assert job.active?
+    end
+
+    should "know when it is working" do
+      @worker.run do
+        assert @worker.working?
+        assert Kthxbye::Job.find(@id, @worker.current_queue ).active?
+      end
+    end
+    
+    should "know which is the current queue" do
+      worker = Kthxbye::Worker.new("*", 0)
+      worker.run do 
+        assert_equal "test", worker.current_queue
+      end
+    end
+
+    should "know which is the current job id" do
+      worker = Kthxbye::Worker.new("*", 0)
+      worker.run do 
+        assert_equal Kthxbye::Job.find(@id, worker.current_queue), worker.current_job
+      end
+    end
+
+    should "find the current job" do
+      @worker.run do
+        assert_equal ({'job_id' => @id, 'started' => Time.now.to_s}), Kthxbye::Worker.working_on(@worker.id)
+      end
+    end
+
+    should "requeue a job and report error if worker is killed mid-process" do
+      @worker.working( Kthxbye::Job.find( @id, "test" ) )
+      @worker.unregister_worker
+      
+      assert_equal 1, Kthxbye::Failure.all.size
+      assert_equal "Kthxbye::ActiveWorkerKilled", Kthxbye::Failure.find(@id)['type']
+      assert_not_nil job = Kthxbye::Job.find( @id, "test" )
+      assert_equal 1, job.failed_attempts
+    end
+
+    should "show a pretty inspect" do
+      assert_equal "#<Worker: #{@worker.id}>", @worker.inspect
+    end
+
+  end
+end

metadata

@@ -0,0 +1,364 @@
+--- !ruby/object:Gem::Specification 
+name: kthxbye
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Luke van der Hoeven
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-23 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: redis
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: yajl-ruby
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: json
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: mail
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: i18n
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: sinatra
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: shoulda
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id007
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: bundler
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id008
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: jeweler
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 270495430
+        segments: 
+        - 1
+        - 5
+        - 0
+        - pre3
+        version: 1.5.0.pre3
+  requirement: *id009
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rcov
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id010
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: shoulda
+  version_requirements: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id011
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: bundler
+  version_requirements: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id012
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: jeweler
+  version_requirements: &id013 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 270495430
+        segments: 
+        - 1
+        - 5
+        - 0
+        - pre3
+        version: 1.5.0.pre3
+  requirement: *id013
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rcov
+  version_requirements: &id014 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id014
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: redis
+  version_requirements: &id015 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 0
+        - 5
+        version: 2.0.5
+  requirement: *id015
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: yajl-ruby
+  version_requirements: &id016 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 7
+        - 7
+        version: 0.7.7
+  requirement: *id016
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: json
+  version_requirements: &id017 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 4
+        - 6
+        version: 1.4.6
+  requirement: *id017
+  type: :runtime
+description: "Kthxbye is the answer to a fairly unique-yet-common problem: Background job processing when we care about the result."
+email: hungerandthirst@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .document
+- .gitignore
+- DESIGN.textile
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- config.ru
+- lib/kthxbye.rb
+- lib/kthxbye/config.rb
+- lib/kthxbye/exceptions.rb
+- lib/kthxbye/failure.rb
+- lib/kthxbye/helper.rb
+- lib/kthxbye/job.rb
+- lib/kthxbye/version.rb
+- lib/kthxbye/web_interface.rb
+- lib/kthxbye/web_interface/public/application.js
+- lib/kthxbye/web_interface/public/awesome-buttons.css
+- lib/kthxbye/web_interface/public/jquery.js
+- lib/kthxbye/web_interface/public/style.css
+- lib/kthxbye/web_interface/views/error.haml
+- lib/kthxbye/web_interface/views/failed.haml
+- lib/kthxbye/web_interface/views/hash.haml
+- lib/kthxbye/web_interface/views/layout.haml
+- lib/kthxbye/web_interface/views/overview.haml
+- lib/kthxbye/web_interface/views/queues.haml
+- lib/kthxbye/web_interface/views/set.haml
+- lib/kthxbye/web_interface/views/stats.haml
+- lib/kthxbye/web_interface/views/view_backtrace.haml
+- lib/kthxbye/web_interface/views/workers.haml
+- lib/kthxbye/web_interface/views/working.haml
+- lib/kthxbye/worker.rb
+- test/helper.rb
+- test/redis-test.conf
+- test/test_failure.rb
+- test/test_helper.rb
+- test/test_kthxbye.rb
+- test/test_worker.rb
+has_rdoc: true
+homepage: http://github.com/plukevdh/kthxbye
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Async processing + results notification
+test_files: 
+- test/helper.rb
+- test/test_failure.rb
+- test/test_helper.rb
+- test/test_kthxbye.rb
+- test/test_worker.rb