kthxbye 1.1.1 → 1.2.0

data/{README.textile → README.rdoc}

@@ -1,4 +1,16 @@
-h1. kthxbye
+== kthxbye
+
+== Quick Links
+
+code: http://github.com/plukevdh/kthxbye
+
+docs: http://rdoc.info/github/plukevdh/kthxbye/
+
+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.
@@ -16,7 +28,7 @@ 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. 
 
-<img src="http://img.skitch.com/20100901-gadna641fj4wdeswgj74y2pssq.png" alt="RLA - IWP Analysis"/>
+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
@@ -29,17 +41,17 @@ 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.
 
-h2. 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?
 I needed some hack time with Redis on my own as I've never used it before...
 
-bq. 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.
+"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_
+-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 
@@ -47,54 +59,54 @@ 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")
-      end
+  # dummy job class
+  class MyJob
+    def self.perform(data)
+      puts "Do something with #{data}"
+      data.gsub(/hello/i, "Goodbye")
     end
+  end
 
-    # 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")
+  # 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")
 
-    # ... 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.
+== Installation
 
-h2. 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
 
-    rails g kthxbye
+  rails g kthxbye
 
 which will install all of the necessary assets, of which there are three:
-# public/javascripts/kthxbye.js - a responder that will catch job status message 
-from the worker
-# public/images/kthxbye_widget.png - a notifier widget to show the status of a 
-job
-# public/stylesheets/kthxbye.css - styles for the widget
+
+1. public/javascripts/kthxbye.js - a responder that will catch job status message from the worker
+2. public/images/kthxbye_widget.png - a notifier widget to show the status of a job
+3. public/stylesheets/kthxbye.css - styles for the widget
 
 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
@@ -104,8 +116,9 @@ 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/ 
 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
+In order to install Socket.io on your application side, run 
+  
+  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
 conflicting way that Socket.io has hardcoded some paths into the code, you may 
@@ -120,8 +133,9 @@ via "git clone git://github.com/LearnBoost/Socket.IO-node.git socket.io-node --r
 (from the socket.io install instructions http://github.com/LearnBoost/Socket.IO-node)
 
 
-h2. Troubleshooting
-h3. The part of the show where I try to save you some trouble
+== Troubleshooting
+
+=== 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:
@@ -133,8 +147,7 @@ You may need to create a link in your public/ dir to socket.io to the install
 in your public/javascripts/ dir. 
 
 
-
-h2. Note on Patches/Pull Requests
+== Note on Patches/Pull Requests
  
 * Fork the project.
 * Make your feature addition or bug fix.
@@ -144,6 +157,6 @@ h2. Note on Patches/Pull Requests
   (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.
 
-h2. Copyright
+== Copyright
 
 Copyright (c) 2010 Luke van der Hoeven. See LICENSE for details.

data/bin/kthxbye-monitor

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+begin 
+  require 'vegas'
+rescue
+  require 'rubygems'
+  require 'vegas'
+end
+
+require 'kthxbye/web_interface'
+require 'kthxbye/config'
+
+Vegas::Runner.new(Kthxbye::WebInterface, 'kthxbye-monitor') do |runner, args, app|
+  Kthxbye::Config.setup
+
+  args.on('-S SERVER', '--server  SERVER', "set the redis server") {|server|
+    Kthxbye::Config.options[:redis_server] = server
+  }
+  args.on('-P PORT', '--port  PORT', "set the redis port") {|port|
+    Kthxbye::Config.options[:redis_port] = port
+  }
+
+end
+

data/config.ru

@@ -1,10 +1,11 @@
 #!/usr/bin/env ruby
 
 $LOAD_PATH.unshift ::File.expand_path(::File.dirname(__FILE__) + '/lib')
-require 'kthxbye'
 require 'kthxbye/web_interface'
 
-Kthxbye::Config.setup(:redis_server => "itwebpriv1", :redis_port => 6379)
-Kthxbye.connect
+if ENV['KTHXBYECONFIG'] && ::File.exists?(::File.expand_path(ENV['KTHXBYECONFIG']))
+  load ::File.expand_path(ENV['KTHXBYECONFIG'])
+end
 
-Kthxbye::WebInterface.run!
+use Rack::ShowExceptions
+Kthxbye::WebInterface.new

data/lib/kthxbye/config.rb

@@ -20,7 +20,7 @@ module Kthxbye
     # 
     # NEEDS TO BE REWORKED FOR RAILS APPS
     def self.setup( args=nil )
-      @options = DEFAULT.dup
+      @options ||= DEFAULT.dup
       @options.merge!( YAML.load('./config/kthxbye.yaml') ) if File.exist?( './config/kthxbye.yaml' )
       @options.merge!( args ) if args
     end

data/lib/kthxbye/version.rb

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

data/lib/kthxbye/worker.rb

@@ -103,8 +103,6 @@ module Kthxbye
     def clean_workers
       workers = Kthxbye.workers 
       known = worker_pids
-      puts workers
-      puts known
       workers.each do |worker|
         host,pid,queues = worker.id.split(":")
         next unless host == hostname

data/test/test_kthxbye.rb

@@ -4,7 +4,7 @@ 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)
+      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]
@@ -23,7 +23,7 @@ class TestKthxbye < Test::Unit::TestCase
 
   context "See Kthxbye" do
     setup do
-      Kthxbye::Config.setup
+      Kthxbye::Config.setup(:verbose => false)
       Kthxbye.redis.flushall
     end
 

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: kthxbye
 version: !ruby/object:Gem::Version 
-  hash: 17
   prerelease: false
   segments: 
   - 1
-  - 1
-  - 1
-  version: 1.1.1
+  - 2
+  - 0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Luke van der Hoeven
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-06 00:00:00 -04:00
+date: 2010-10-08 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -27,8 +26,9 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.textile
+- README.rdoc
 files: 
+- bin/kthxbye-monitor
 - lib/kthxbye/version.rb
 - lib/kthxbye/job.rb
 - lib/kthxbye/exceptions.rb
@@ -61,7 +61,7 @@ files:
 - lib/generators/kthxbye/kthxbye_generator.rb
 - lib/kthxbye.rb
 - LICENSE
-- README.textile
+- README.rdoc
 - DESIGN.textile
 - config.ru
 - Gemfile
@@ -85,7 +85,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -94,7 +93,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 23
       segments: 
       - 1
       - 3