jobit 0.0.2 → 0.0.3

data/.travis.yml

@@ -0,0 +1,2 @@
+rvm:
+  - 1.9.2

data/CHANGELOG.md

@@ -1,7 +1,11 @@
-## v0.0.1
+## v0.0.3
 
-* initial release
+* README updated
 
 ## v0.0.2
 
-* updated gem homepage
+* updated gem homepage
+
+## v0.0.1
+
+* initial release

data/README.md

@@ -1 +1,94 @@
-nothing yet
+# Jobit [![Build Status](https://secure.travis-ci.org/vtg/jobit.png)](http://travis-ci.org/vtg/jobit)
+
+Jobit helps to manage background jobs processing with job status and progress monitoring.
+
+## Installation
+
+Add to your Gemfile and run the `bundle` command to install it.
+
+```ruby
+gem "jobit"
+```
+
+**Requires Ruby 1.9.2 or later.**
+
+
+## Usage
+
+Create jobs file app/model/jobit_items.rb and put your tasks there:
+
+```ruby
+method JobitItems
+
+  def some_long_running_task_without_response(arg)
+    sleep 60
+  end
+
+  def some_long_running_task_with_response(arg1, arg2)
+    add_message("job #{name} started\n")
+    set_progress(10)
+    sleep 60
+    set_progress(80)
+    add_message("job #{name} half complete\n")
+    sleep 10
+    add_message("job #{name} complete\n")
+  end
+
+end
+```
+
+###Running worker to process the jobs queue
+
+```ruby
+rake jobit:work
+```
+
+
+###Adding jobs to queue
+
+```ruby
+#job will be added to queue and processed. After successful processing it will be destroyed
+new_job = Jobit::Job.add("job_name", :some_long_running_task_without_response, 'val1')
+
+#job will be added to queue and processed. After processing it wont be destroyed so you can see its messages and progress
+new_job = Jobit::Job.add("job_name", :some_long_running_task_with_response, 'val1', 'val2'){{ :keep => true }}
+```
+
+###Monitoring job progress and responses
+
+```ruby
+#returns nil if job not in queue
+job = Jobit::Job.find_by_name('job_name')
+
+job.status #current job status
+job.message #job responses in defined in job
+job.progress #job progress
+job.error #job error if status is "failed"
+```
+
+###Monitoring job progress from your rails application
+
+in routes.rb add:
+
+```ruby
+mount Jobit::Engine => "/jobs"
+```
+
+now in your can see the status of job in your browser
+
+```ruby
+http://127.0.0.1:3000/jobs/job_name
+```
+It will return the job with name "job_name" in json format
+
+
+##Cleaning jobs
+
+```ruby
+rake jobit:clear # destroying all jobs in the queue.
+rake jobit:clear_failed # destroying only failed jobs in the queue.
+```
+
+*More details coming soon*
+
+

data/jobit.gemspec

@@ -16,5 +16,6 @@ Gem::Specification.new do |gem|
   gem.version       = Jobit::VERSION
   
   gem.add_dependency "daemons"
+  gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec"
 end

data/lib/jobit/job.rb

@@ -9,7 +9,7 @@ module Jobit
       if defined?(Rails)
         "#{Rails.root.to_s}/tmp/jobit"
       else
-        File.dirname(__FILE__) + "/../../tmp/jobit"
+        "/tmp/jobit"
       end
     end
 
@@ -33,7 +33,7 @@ module Jobit
       if defined?(Rails)
         Logger.new("#{Rails.root.to_s}/log/jobit.log", shift_age = 7, shift_size = 1048576)
       else
-        Logger.new(File.dirname(__FILE__) + "/../../log/jobit.log")
+        Logger.new('/dev/null')
       end
     end
 

data/lib/jobit/version.rb

@@ -1,3 +1,3 @@
 module Jobit
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jobit
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-03 00:00:00.000000000Z
+date: 2011-12-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: daemons
-  requirement: &2158543940 !ruby/object:Gem::Requirement
+  requirement: &2166619500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2158543940
+  version_requirements: *2166619500
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2166619080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2166619080
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2158543520 !ruby/object:Gem::Requirement
+  requirement: &2166618660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2158543520
+  version_requirements: *2166618660
 description: Process background jobs in queue.
 email:
 - v.t.g.m.b.x@gmail.com
@@ -42,6 +53,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - LICENSE