creeper 0.0.1 → 0.0.2

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/README.md

@@ -1,29 +1,79 @@
 # Creeper
 
-TODO: Write a gem description
+Can be used as an in place drop in for stalker but it is multi threaded so you can easily do more without using more memory
 
-## Installation
+Creeper - an improvement on Stalker
+==========================================
 
-Add this line to your application's Gemfile:
+The big difference is how you "work" jobs
 
-    gem 'creeper'
+all you need is a thread count arguement :)
 
-And then execute:
+    Creeper.work(<jobs>, <thread_count>)
 
-    $ bundle
+[Beanstalkd](http://kr.github.com/beanstalkd/) is a fast, lightweight queueing backend inspired by mmemcached.
 
-Or install it yourself as:
+Queueing jobs
+-------------
 
-    $ gem install creeper
+From anywhere in your app:
 
-## Usage
+    require 'creeper'
 
-TODO: Write usage instructions here
+    Creeper.enqueue('email.send', :to => 'joe@example.com')
+    Creeper.enqueue('post.cleanup.all')
+    Creeper.enqueue('post.cleanup', :id => post.id)
 
-## Contributing
+Working jobs
+------------
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+In a standalone file, typically jobs.rb or worker.rb:
+
+    require 'creeper'
+    include Creeper
+
+    job 'email.send' do |args|
+      Pony.send(:to => args['to'], :subject => "Hello there")
+    end
+
+    job 'post.cleanup.all' do |args|
+      Post.all.each do |post|
+        enqueue('post.cleanup', :id => post.id)
+      end
+    end
+
+    job 'post.cleanup' do |args|
+      Post.find(args['id']).cleanup
+    end
+    
+    Creeper.work(<jobs>, <thread_count>)
+
+Running
+-------
+
+First, make sure you have Beanstalkd installed and running:
+
+    $ sudo brew install beanstalkd
+    $ beanstalkd
+
+Creeper:
+
+    $ sudo gem install creeper
+
+Error Handling
+-------------
+
+If you include an `error` block in your jobs definition, that block will be invoked when a worker encounters an error. You might use this to report errors to an external monitoring service:
+
+    error do |e, job, args|
+      Exceptional.handle(e)
+    end
+
+Before filter
+-------------
+
+If you wish to run a block of code prior to any job:
+
+    before do |job|
+      puts "About to work #{job}"
+    end

data/lib/creeper/version.rb

@@ -1,3 +1,3 @@
 module Creeper
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/creeper_spec.rb

@@ -0,0 +1,141 @@
+require 'spec_helper'
+
+describe Creeper do
+
+  after :each do
+    Creeper.clear!
+  end
+  
+  it "work a job and do it up" do
+    val = rand(999999)
+    Creeper.job('my.job') { |args| $result = args['val'] }
+    Creeper.enqueue('my.job', :val => val)
+    w = Creeper::Worker.new
+    w.stub(:exception_message)
+    w.stub(:log)
+    w.prep
+    w.work_one_job
+    val.should == $result
+  end
+
+  it "invoke error handler when defined" do
+    with_an_error_handler
+    Creeper.job('my.job') { |args| fail }
+    Creeper.enqueue('my.job', :foo => 123)
+    w = Creeper::Worker.new
+    w.stub(:exception_message)
+    w.stub(:log)
+    w.prep
+    w.work_one_job
+    $handled.should_not == nil
+    'my.job'.should == $job_name
+    {'foo' => 123}.should ==  $job_args
+  end
+
+  it "should be compatible with legacy error handlers" do
+    exception = StandardError.new("Oh my, the job has failed!")
+    Creeper.error { |e| $handled = e }
+    Creeper.job('my.job') { |args| raise exception }
+    Creeper.enqueue('my.job')
+    w = Creeper::Worker.new
+    w.stub(:exception_message)
+    w.stub(:log)
+    w.prep
+    w.work_one_job
+    exception.should == $handled
+  end
+
+  it "continue working when error handler not defined" do
+    Creeper.error { |e| $handled = false }
+    Creeper.job('my.job') { fail }
+    Creeper.enqueue('my.job')
+    w = Creeper::Worker.new
+    w.stub(:exception_message)
+    w.stub(:log)
+    w.prep
+    w.work_one_job
+    false.should == $handled
+  end
+
+  it "exception raised one second before beanstalk ttr reached" do
+    with_an_error_handler
+    Creeper.job('my.job') { sleep(3); $handled = "didn't time out" }
+    Creeper.enqueue('my.job', {}, :ttr => 2)
+    w = Creeper::Worker.new
+    w.stub(:exception_message)
+    w.stub(:log)
+    w.prep
+    w.work_one_job
+    $handled.should == "didn't time out"
+  end
+
+  it "before filter gets run first" do
+    Creeper.before { |name| $flag = "i_was_here" }
+    Creeper.job('my.job') { |args| $handled = ($flag == 'i_was_here') }
+    Creeper.enqueue('my.job')
+    w = Creeper::Worker.new
+    w.stub(:exception_message)
+    w.stub(:log)
+    w.prep
+    w.work_one_job
+    true.should == $handled
+  end
+
+  it "before filter passes the name of the job" do
+    Creeper.before { |name| $jobname = name }
+    Creeper.job('my.job') { true }
+    Creeper.enqueue('my.job')
+    w = Creeper::Worker.new
+    w.stub(:exception_message)
+    w.stub(:log)
+    w.prep
+    w.work_one_job
+    'my.job'.should == $jobname
+  end
+
+  it "before filter can pass an instance var" do
+    Creeper.before { |name| @foo = "hello" }
+    Creeper.job('my.job') { |args| $handled = (@foo == "hello") }
+    Creeper.enqueue('my.job')
+    w = Creeper::Worker.new
+    w.stub(:exception_message)
+    w.stub(:log)
+    w.prep
+    w.work_one_job
+    true.should == $handled
+  end
+
+  it "before filter invokes error handler when defined" do
+    with_an_error_handler
+    Creeper.before { |name| fail }
+    Creeper.job('my.job') {  }
+    Creeper.enqueue('my.job', :foo => 123)
+    w = Creeper::Worker.new
+    w.stub(:exception_message)
+    w.stub(:log)
+    w.prep
+    w.work_one_job
+    $handled.should_not == nil
+    'my.job'.should ==  $job_name
+    {'foo' => 123}.should == $job_args
+  end
+  
+  it "parse BEANSTALK_URL" do
+    ENV['BEANSTALK_URL'] = "beanstalk://localhost:12300"
+    Creeper.beanstalk_addresses.should == ["localhost:12300"]
+    ENV['BEANSTALK_URL'] = "beanstalk://localhost:12300/, beanstalk://localhost:12301/"
+    Creeper.beanstalk_addresses.should == ["localhost:12300","localhost:12301"]
+    ENV['BEANSTALK_URL'] = "beanstalk://localhost:12300   beanstalk://localhost:12301"
+    Creeper.beanstalk_addresses.should == ["localhost:12300","localhost:12301"]
+  end
+
+  def with_an_error_handler
+    Creeper.error do |e, job_name, args|
+      $handled = e.class
+      $job_name = job_name
+      $job_args = args
+    end
+  end
+
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'bundler/setup'
+
+$:.push File.expand_path("../lib", __FILE__)
+require 'creeper'
+require 'pry'
+
+
+RSpec.configure do |config|
+end

data/spec/worker_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Creeper::Worker do
+  # before :each do
+  #   @base = Monitor::Base.new  
+  # end
+
+  # after :each do
+  #   @base = nil
+  # end
+  
+  it "shoud not create a vz object" do
+    2.should == 2
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: creeper
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -67,6 +67,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE
 - README.md
@@ -75,6 +76,9 @@ files:
 - lib/creeper.rb
 - lib/creeper/version.rb
 - lib/creeper/worker.rb
+- spec/creeper_spec.rb
+- spec/spec_helper.rb
+- spec/worker_spec.rb
 homepage: https://github.com/lyondhill/creeper
 licenses: []
 post_install_message: 
@@ -100,5 +104,8 @@ signing_key:
 specification_version: 3
 summary: A better solution for io bound jobs, same as stalker in functionality but
   more threadie.
-test_files: []
+test_files:
+- spec/creeper_spec.rb
+- spec/spec_helper.rb
+- spec/worker_spec.rb
 has_rdoc: