kthxbye 1.0.5 → 1.1.0

data/Gemfile

@@ -8,15 +8,14 @@ source "http://rubygems.org"
 group :development do
   gem "shoulda", ">= 0"
   gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.0.pre3"
   gem "rcov", ">= 0"
 end
 
 gem "redis"
+
 begin
   gem "yajl-ruby"
 rescue
   gem "json"
 end
 
-gem 'sinatra'

data/README.textile

@@ -76,6 +76,64 @@ and then in some other world, on some other machine, (that still has knowledge o
 
 Pretty... damn... simple.
 
+h2. Installation
+Installation isn't hard. Simply:
+
+    gem install kthxbye
+
+or in Rails
+
+    gem "kthxbye"
+
+and then in your project directory run
+
+    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
+
+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/ 
+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
+
+*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
+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 
+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)
+
+
+h2. Troubleshooting
+h3. 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:
+
+You will need to run node as root user if you want to take advantage of 
+flashsockets.
+
+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
  
 * Fork the project.

data/lib/generators/kthxbye/USAGE

@@ -0,0 +1,11 @@
+Description:
+  The 'kthxbye' command installs the necessary resource files to your Rails
+  application so that you can use the notification widget and modify any
+  job completion actions for the front-end
+
+Example:
+  rails g kthxbye:all
+
+  This installs all the resource files (images, javascripts, css files) into
+  the proper locations in your public/ dir.
+  

data/lib/generators/kthxbye/kthxbye_generator.rb

@@ -0,0 +1,51 @@
+require 'rails/generators'
+
+module Kthxbye
+  module Generators
+    class KthxbyeGenerator < Rails::Generators::Base
+
+      desc "installs all necessary Kthxbye files for notification widget"
+
+      class_option :js, :type => :boolean, :default => true, :desc => "install javascript files"
+      class_option :img, :type => :boolean, :default => true, :desc => "install widget image"
+      class_option :css, :type => :boolean, :default => true, :desc => "install css files"
+
+      def self.source_root
+        @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+      end
+
+      def self.banner
+        "#{$0} kthxbye #{self.arguments.map{ |a| a.usage }.join(' ')} [options]"
+      end
+
+      def install_all
+        install_javascripts
+        install_css
+        install_images
+        install_gems
+
+        puts "Successfully installed Kthxbye resources in public/"
+      end
+
+      private
+
+      def install_javascripts
+        copy_file("kthxbye.js", "public/javascripts/kthxbye.js") if options[:js]
+      end
+
+      def install_css
+        copy_file("kthxbye.css", "public/stylesheets/kthxbye.css") if options[:css]
+      end
+
+      def install_images
+        copy_file("kthxbye_widget.png", "public/images/kthxbye_widget.png") if options[:img]
+      end
+
+      def install_gems
+        gem("redis", "~> 2.0.10")
+        gem("yajl-ruby", "~> 0.7.8")
+        gem("kthxbye", "~> #{Kthxbye::Version}")
+      end
+    end
+  end
+end

data/lib/generators/kthxbye/templates/kthxbye.css

@@ -0,0 +1,18 @@
+#kthxbye {
+  height: 41px;
+  width: 124px;
+  background:url('../images/kthxbye_widget.png') no-repeat;
+  margin:10px;
+}
+
+#kthxbye.failed {
+  background-position: 0 -120px;
+}
+
+#kthxbye.success {
+  background-position: 0 -40px;
+}
+
+#kthxbye.active {
+  background-position: 0 -80px;
+}

data/lib/generators/kthxbye/templates/kthxbye.js

@@ -0,0 +1,41 @@
+io.setPath("/javascripts/socket.io/")
+var socket = new io.Socket('localhost', {port:8081}) 
+
+function active() {
+  $('#kthxbye').removeClass("failed success").addClass("active")
+}
+
+function failed() {
+  $('#kthxbye').removeClass("active success").addClass("failed")
+}
+
+function succeeded() {
+  $('#kthxbye').removeClass("active failed").addClass("success")
+}
+
+
+
+if(socket.connect()) {
+  socket.on('message', function(data) {
+    try {
+      var status = JSON.parse(data)
+    } catch (SyntaxError) {
+      return false;
+    }
+    
+    if(status.id != parseInt(job_id)) return false;
+
+    if(status.status == 'job.failed') {
+      failed()
+    } else if(status.status == 'job.completed') {
+      succeeded()
+    } else if(status.status == 'job.started') {
+      active()
+    } else {
+      alert('Unknown option! ' + status.status)
+    }
+    
+    return false
+  })
+}
+

data/lib/kthxbye.rb

@@ -6,8 +6,6 @@ rescue
   require 'json'
 end
 
-$LOAD_PATH << './lib'
-
 require 'kthxbye/config'
 require 'kthxbye/helper'
 require 'kthxbye/job'
@@ -18,6 +16,8 @@ require 'kthxbye/version'
 
 require 'kthxbye/exceptions'
 
+require 'kthxbye/railtie' if defined?(Rails) && Rails::VERSION::MAJOR == 3
+
 # Kthxbye is a light-weight, distributed delayed-job processor. It is meant
 # to take the load of long running processes off of your web-server any place 
 # it in the capable hands of a backend processor. It is unique in that it 

data/lib/kthxbye/job.rb

@@ -111,6 +111,8 @@ module Kthxbye
     # It will get the jobs class, payload and then run the job, storing the
     # result in the result's store once complete. Also responsible for reporting
     # errors and storing the job in the failure listing if an exception occurs.
+    # Will also publish a message on the job.failed channel (Redis PUBSUB) with
+    # the id of the failed job
     def perform
       begin
         @klass = Object.const_get(@data['klass'])
@@ -124,6 +126,7 @@ module Kthxbye
       rescue Object => ex
         @failed_attempts += 1
         log "Error occured: #{ex.message}. Try: #{@failed_attempts}/#{Kthxbye::Config.options[:attempts]}"
+        redis.publish("job.failed", @id)
         return Kthxbye::Failure.create( self, ex ) if @failed_attempts >= Kthxbye::Config.options[:attempts]
         perform
       end

data/lib/kthxbye/railtie.rb

@@ -0,0 +1,18 @@
+# Rake tasks and integration to Rails
+# require 'kthxbye'
+
+module Kthxbye
+  class Railtie < Rails::Railtie
+
+    config.action_view.javascript_expansions[:kthxbye] = %w(socket.io/socket.io.js kthxbye.js)
+
+    initializer "kthxbye.configure_for_rails" do |app|   
+      app.config.autoload_paths += %W(kthxbye/css kthxbye/javascripts kthxbye/images)
+    end
+
+    rake_tasks do
+      load "kthxbye/railties/kthxbye.rake"
+    end
+
+  end
+end

data/lib/kthxbye/railties/kthxbye.rake

@@ -0,0 +1,3 @@
+namespace :kthxbye do
+end
+

data/lib/kthxbye/version.rb

@@ -1,5 +1,5 @@
 module Kthxbye
   # Returns current version of Kthxbye
-  Version = VERSION = File.read(File.dirname(__FILE__)+'/../../VERSION').chomp
+  Version = VERSION = "1.1.0"
 end
 

data/lib/kthxbye/worker.rb

@@ -133,6 +133,7 @@ module Kthxbye
 
       # activates job
       job.active
+      redis.publish("job.started", job.id)
     end
 
     # Is this job working?
@@ -145,6 +146,7 @@ module Kthxbye
       redis.srem( :working, self )
       redis.del( "worker:#{self}" )
       log "Completed job #{@current_job}"
+      redis.publish("job.completed", @current_job.id)
       @current_job = nil
     end
 

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: kthxbye
 version: !ruby/object:Gem::Version 
-  hash: 29
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 5
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors: 
 - Luke van der Hoeven
@@ -15,112 +14,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-24 00:00:00 -04:00
+date: 2010-10-05 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: sinatra
-  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: shoulda
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id004
-  type: :development
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  name: bundler
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
-  requirement: *id005
-  type: :development
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  name: jeweler
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 270495430
-        segments: 
-        - 1
-        - 5
-        - 0
-        - pre3
-        version: 1.5.0.pre3
-  requirement: *id006
-  type: :development
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  name: rcov
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id007
-  type: :development
+dependencies: []
+
 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: []
@@ -131,46 +28,48 @@ 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/job.rb
+- lib/kthxbye/exceptions.rb
 - lib/kthxbye/web_interface.rb
+- lib/kthxbye/web_interface/public/jquery.js
 - 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/workers.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/failed.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/layout.haml
+- lib/kthxbye/web_interface/views/queues.haml
+- lib/kthxbye/web_interface/views/error.haml
+- lib/kthxbye/web_interface/views/stats.haml
 - lib/kthxbye/web_interface/views/working.haml
+- lib/kthxbye/failure.rb
+- lib/kthxbye/config.rb
+- lib/kthxbye/railtie.rb
+- lib/kthxbye/helper.rb
 - lib/kthxbye/worker.rb
-- test/helper.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.textile
+- DESIGN.textile
+- config.ru
+- Gemfile
+- test/test_kthxbye.rb
 - test/redis-test.conf
-- test/test_failure.rb
 - test/test_helper.rb
-- test/test_kthxbye.rb
+- test/test_failure.rb
 - test/test_worker.rb
+- test/helper.rb
 has_rdoc: true
 homepage: http://github.com/plukevdh/kthxbye
 licenses: []
@@ -185,7 +84,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -194,10 +92,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: []
 
 rubyforge_project: 
@@ -206,8 +105,9 @@ 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/redis-test.conf
+- test/test_helper.rb
+- test/test_failure.rb
 - test/test_worker.rb
+- test/helper.rb

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE

data/.gitignore

@@ -1,33 +0,0 @@
-# rcov generated
-coverage
-
-# rdoc generated
-rdoc
-
-# yard generated
-doc
-.yardoc
-
-# bundler
-.bundle
-
-# jeweler generated
-pkg
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-*.swo
-
-## PROJECT::SPECIFIC
-*.gemspec

data/Gemfile.lock

@@ -1,28 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    git (1.2.5)
-    jeweler (1.5.0.pre3)
-      bundler (~> 1.0.0)
-      git (>= 1.2.5)
-      rake
-    rack (1.2.1)
-    rake (0.8.7)
-    rcov (0.9.9)
-    redis (2.0.10)
-    shoulda (2.11.3)
-    sinatra (1.0)
-      rack (>= 1.0)
-    yajl-ruby (0.7.7)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.0.0)
-  jeweler (~> 1.5.0.pre3)
-  rcov
-  redis
-  shoulda
-  sinatra
-  yajl-ruby

data/Rakefile

@@ -1,46 +0,0 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  gem.name = "kthxbye"
-  gem.summary = %Q{Async processing + results notification}
-  gem.description = %Q{Kthxbye is the answer to a fairly unique-yet-common problem: Background job processing when we care about the result.}
-  gem.email = "hungerandthirst@gmail.com"
-  gem.homepage = "http://github.com/plukevdh/kthxbye"
-  gem.authors = ["Luke van der Hoeven"]
-end
-Jeweler::RubygemsDotOrgTasks.new
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "kthxbye #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end

data/VERSION

@@ -1 +0,0 @@
-1.0.5