kthxbye 1.3.0 → 1.3.2

data/{README.rdoc → README.md}

@@ -1,16 +1,20 @@
-== kthxbye
+# kthxbye
 
-== Quick Links
+Delayed job processing with async job completion and results notificiation*
 
-code: http://github.com/plukevdh/kthxbye
+_* depends on [Node.js][1] and [Socket.io][2]_
 
-docs: http://rdoc.info/github/plukevdh/kthxbye/
+## Quick Links
 
-gem: https://rubygems.org/gems/kthxbye
+code: <http://github.com/plukevdh/kthxbye>
 
-issues: http://github.com/plukevdh/kthxbye/issues
+docs: <http://rdoc.info/github/plukevdh/kthxbye/>
 
-== History
+gem: <https://rubygems.org/gems/kthxbye>
+
+issues: <http://github.com/plukevdh/kthxbye/issues>
+
+## History
 
 Kthxbye is the answer to a fairly unique-yet-common problem: Background job 
 processing when we care about the result.
@@ -22,13 +26,13 @@ operation to be returned to the user.
 
 Here's a real-world example. I work with a set of legacy Oracle databases that
 stores much of our business logic as PLSQL procedures. Yes, this is not "The
-Rails Way&#0153;" but it's the only way for the company I work for right now.
+Rails Way &trade;" but it's the only way for the company I work for right now.
 Many of the procedures that I run as part of several of the applications I 
 support can take on average one minute or more with a standard deviation of
 almost 2 minutes (with a forced timeout of 5 minutes). That's kinda a long time
 to sit and wait on a web app. 
 
-http://img.skitch.com/20100901-gadna641fj4wdeswgj74y2pssq.png
+![Stats](http://img.skitch.com/20100901-gadna641fj4wdeswgj74y2pssq.png)
 
 We don't really want users sitting waiting for up to 5 minutes (when it forces 
 failure) unable to do anything or (even worse) hitting refresh or the action
@@ -36,22 +40,23 @@ again. Especially bad when this can mean the HTTP server is getting backed up
 as more and more people run these long running processes.
 
 Moreover, the users need to get response from the completed job before moving
-on. Most job processors (DJ, Resque) are setup for running jobs that do not
+on. Most job processors ([DJ][4], [Resque][3]) are setup for running jobs that do not
 require the result to be returned to the web app (think mass-mailers, queue
 population, image resizing). They just run and the output goes to a database,
 an inbox or a file server.
 
-=== Enter Kthxbye
+## Enter Kthxbye
 
 Kthxbye is an attempt to solve this problem. It is based heavily off of 
-"Resque":http://github.com/defunkt/resque and why not an addition to Resque?
+[Resque][3] and why not an addition to Resque?
 I needed some hack time with Redis on my own as I've never used it before...
 
-"I can learn any language or tool in a matter of days if you give me 
-1. a good manual
-2. an even better project to work on."
-
--Prof. Shumacher
+> I can learn any language or tool in a matter of days if you give me 
+> 
+> 1. a good manual
+> 2. an even better project to work on.
+> 
+> _-Prof. Shumacher_
 
 This project accomplishes both those goals. This is an attempt to learn 
 something, using Resque and Redis docs as a manual, while at the same time 
@@ -59,48 +64,48 @@ creating a much needed solution to a problem.
 
 The idea is to be able to do the following:
 
-  # dummy job class
-  class MyJob
-    def self.perform(data)
-      puts "Do something with #{data}"
-      data.gsub(/hello/i, "Goodbye")
+    # dummy job class
+    class MyJob
+      def self.perform(data)
+        puts "Do something with #{data}"
+        data.gsub(/hello/i, "Goodbye")
+      end
     end
-  end
 
-  # setup options, then connect
-  Kthxbye::Config.setup(:redis_server => 'localhost', :redis_port => 8080)
+    # setup options, then connect
+    Kthxbye::Config.setup(:redis_server => 'localhost', :redis_port => 8080)
   
-  # each enqueued job returns a unique id to poll with
-  unique_id = Kthxbye.enqueue("jobs", MyJob, "Hello World")
+    # each enqueued job returns a unique id to poll with
+    unique_id = Kthxbye.enqueue("jobs", MyJob, "Hello World")
 
-  # ... code code code ...
+    # ... code code code ...
 
-  # polls queue every 5 seconds
-  computed_value = Kthxbye.poll("jobs", unique_id, 5)
+    # polls queue every 5 seconds
+    computed_value = Kthxbye.poll("jobs", unique_id, 5)
 
 and then in some other world, on some other machine, (that still has knowledge of MyJob)
 
-  # inits with queue
-  worker = Kthxbye::Worker.new("jobs")
+    # inits with queue
+    worker = Kthxbye::Worker.new("jobs")
 
-  # connects to queue and runs jobs found there
-  worker.run
+    # connects to queue and runs jobs found there
+    worker.run
 
-*Pretty... damn... simple.*
+**Pretty... damn... simple.&trade;**
 
-== Installation
+## Installation
 
 Installation isn't hard. Simply:
 
-  gem install kthxbye
+    gem install kthxbye
 
 or in Rails
 
-  gem "kthxbye"
+    gem "kthxbye"
 
-and then in your project directory run
+and then in your project directory (if using Rails) run
 
-  rails g kthxbye
+    rails g kthxbye
 
 which will install all of the necessary assets, of which there are three:
 
@@ -112,30 +117,32 @@ These can be ignored if you really don't want to have an asynchronus widget to
 display the job's status to the user in real-time. You can simply use the gem
 and get the results on your own time.
 
-If are using the widget however, we depend on "node.js":http://nodejs.org/ to 
-handle the Redis PUBSUB listening and updating and "Socket.io":http://socket.io/ 
+If are using the widget however, we depend on [node.js][1] to 
+handle the Redis PUBSUB listening and updating and [Socket.io][2]
 to stream the results back to the clients.
 
 In order to install Socket.io on your application side, run 
   
-  git clone http://github.com/LearnBoost/Socket.IO.git socket-io --recursive
+    git clone http://github.com/LearnBoost/Socket.IO.git socket-io --recursive
 
-*Note:* due to the way Rails tries to serve these files and the seemingly
+**Note:** due to the way Rails tries to serve these files and the seemingly
 conflicting way that Socket.io has hardcoded some paths into the code, you may 
 need to create a symlink to the public/javascripts/socket.io directory in you
 public directory. This was the easiest solution I found.
 
-There is a separate node.js client at "github.com/plukevdh/kthxbye-node":http://github.com/plukevdh/kthxbye-node
+There is a separate node.js client at <http://github.com/plukevdh/kthxbye-node>.
 Simply clone the repo or download the poll.js file and set it up to your hearts 
-content. *NOTE:* You will need to configure your ports/redis server in the 
+content. 
+
+*NOTE:* You will need to configure your ports/redis server in the 
 poll.js file as well as installing socket.io in the same dir as the poll.js file
-via "git clone git://github.com/LearnBoost/Socket.IO-node.git socket.io-node --recursive"
-(from the socket.io install instructions http://github.com/LearnBoost/Socket.IO-node)
+via `git clone git://github.com/LearnBoost/Socket.IO-node.git socket.io-node --recursive`
+(from the [socket.io][2] install instructions <http://github.com/LearnBoost/Socket.IO-node>)
 
 
-== Troubleshooting
+## Troubleshooting
 
-=== The part of the show where I try to save you some trouble
+### The part of the show where I try to save you some trouble
 
 There are a few things I found along the way that were necessary to make this
 integration run super smoothly:
@@ -147,16 +154,21 @@ You may need to create a link in your public/ dir to socket.io to the install
 in your public/javascripts/ dir. 
 
 
-== Note on Patches/Pull Requests
+## Want to Help? Rock on. 
  
-* 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, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 Luke van der Hoeven. See LICENSE for details.
+* Fork.
+* Add or fix stuff. 
+* Prove it works with everything else. 
+* Commit changes.
+* Send me a pull request!
+* Glory in the fact that your name is now in the annals of open-sourcedom.
+* Repeat.
+
+## Copyright
+
+Copyright &copy; 2010 Luke van der Hoeven. See LICENSE for details.
+
+[1]: http://nodejs.org
+[2]: http://socket.io
+[3]: http://github.com/defunkt/resque
+[4]: http://github.com/tobi/delayed_job

data/lib/kthxbye/job.rb

@@ -122,6 +122,7 @@ module Kthxbye
 
         result = @klass.send(:perform, *@payload)
         redis.hset( "result-store:#{@queue}", @id, encode( result ) )
+        redis.publish("job.completed", @id)
         return result
       rescue Object => ex
         # handled by worker

data/lib/kthxbye/version.rb

@@ -1,5 +1,5 @@
 module Kthxbye
   # Returns current version of Kthxbye
-  Version = VERSION = "1.3.0"
+  Version = VERSION = "1.3.2"
 end
 

data/lib/kthxbye/worker.rb

@@ -179,7 +179,6 @@ module Kthxbye
       redis.srem( :working, self )
       redis.del( "worker:#{self}" )
       log "Completed job #{@current_job}"
-      redis.publish("job.completed", @current_job.id)
       Stats.incr("processed")
       Stats.incr("processed:#{self}")
       @current_job = nil

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: kthxbye
 version: !ruby/object:Gem::Version 
-  hash: 27
   prerelease: false
   segments: 
   - 1
   - 3
-  - 0
-  version: 1.3.0
+  - 2
+  version: 1.3.2
 platform: ruby
 authors: 
 - Luke van der Hoeven
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-11 00:00:00 -04:00
+date: 2010-12-01 00:00:00 -05:00
 default_executable: kthxbye-monitor
 dependencies: []
 
@@ -27,53 +26,53 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.md
 files: 
 - bin/kthxbye-monitor
-- lib/kthxbye/version.rb
-- lib/kthxbye/job.rb
+- lib/generators/kthxbye/kthxbye_generator.rb
+- lib/generators/kthxbye/templates/kthxbye.css
+- lib/generators/kthxbye/templates/kthxbye.js
+- lib/generators/kthxbye/templates/kthxbye_widget.png
+- lib/generators/kthxbye/USAGE
+- lib/kthxbye/config.rb
 - lib/kthxbye/exceptions.rb
-- lib/kthxbye/web_interface.rb
-- lib/kthxbye/web_interface/public/jquery.js
+- lib/kthxbye/failure.rb
+- lib/kthxbye/helper.rb
+- lib/kthxbye/job.rb
+- lib/kthxbye/railtie.rb
+- lib/kthxbye/railties/kthxbye.rake
+- lib/kthxbye/stats.rb
+- lib/kthxbye/version.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/workers.haml
+- 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/failed.haml
-- lib/kthxbye/web_interface/views/set.haml
 - lib/kthxbye/web_interface/views/queue.haml
-- lib/kthxbye/web_interface/views/view_backtrace.haml
-- lib/kthxbye/web_interface/views/layout.haml
 - lib/kthxbye/web_interface/views/queues.haml
-- lib/kthxbye/web_interface/views/error.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/failure.rb
-- lib/kthxbye/config.rb
-- lib/kthxbye/railtie.rb
-- lib/kthxbye/stats.rb
-- lib/kthxbye/helper.rb
+- lib/kthxbye/web_interface.rb
 - lib/kthxbye/worker.rb
-- lib/kthxbye/railties/kthxbye.rake
-- lib/generators/kthxbye/templates/kthxbye.css
-- lib/generators/kthxbye/templates/kthxbye_widget.png
-- lib/generators/kthxbye/templates/kthxbye.js
-- lib/generators/kthxbye/USAGE
-- lib/generators/kthxbye/kthxbye_generator.rb
 - lib/kthxbye.rb
 - LICENSE
-- README.rdoc
+- README.md
 - DESIGN.textile
 - config.ru
 - Gemfile
-- test/test_kthxbye.rb
+- test/helper.rb
 - test/redis-test.conf
-- test/test_helper.rb
 - test/test_failure.rb
+- test/test_helper.rb
+- test/test_kthxbye.rb
 - test/test_worker.rb
-- test/helper.rb
 has_rdoc: true
 homepage: http://github.com/plukevdh/kthxbye
 licenses: []
@@ -88,7 +87,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -97,7 +95,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 23
       segments: 
       - 1
       - 3
@@ -111,9 +108,9 @@ signing_key:
 specification_version: 3
 summary: Async processing + results notification
 test_files: 
-- test/test_kthxbye.rb
+- test/helper.rb
 - test/redis-test.conf
-- test/test_helper.rb
 - test/test_failure.rb
+- test/test_helper.rb
+- test/test_kthxbye.rb
 - test/test_worker.rb
-- test/helper.rb