komrade-client 1.0.2 → 1.0.5

data/lib/komrade-client.rb

@@ -17,6 +17,7 @@ module Komrade
   end
 
   def log(data)
+    data.merge!(:lib => 'komrade-client')
     result = nil
     if data.key?(:measure)
       data[:measure].insert(0, "komrade.")
@@ -34,3 +35,5 @@ module Komrade
   end
 
 end
+
+require 'komrade-client/queue'

data/lib/komrade-client/http_helpers.rb

@@ -8,6 +8,10 @@ module Komrade
     extend self
     MAX_RETRY = 4
 
+    def post(path, body=nil)
+      make_request(Net::HTTP::Post.new(path), body)
+    end
+
     def put(path, body=nil)
       make_request(Net::HTTP::Put.new(path), body)
     end
@@ -63,7 +67,7 @@ module Komrade
     end
 
     def http
-      @http ||= Net::HTTP.new(Komrade.url.host, Komrade.url.port).tap do |h|
+      Net::HTTP.new(Komrade.url.host, Komrade.url.port).tap do |h|
         if Komrade.url.scheme == 'https'
           h.use_ssl = true
           h.verify_mode = OpenSSL::SSL::VERIFY_NONE

data/lib/komrade-client/queue.rb

@@ -7,19 +7,53 @@ module Komrade
     extend self
     extend HttpHelpers
 
+    # Generates a UUID for the job and sends it to komrade.
+    #
+    # Fast operation.
     def enqueue(method, *args)
       SecureRandom.uuid.tap do |id|
-        put("/jobs/#{id}", method: method, args: args)
+        log(:at => "enqueue-job", :job => id, :method => method) do
+          put("/jobs/#{id}", method: method, args: args)
+        end
       end
     end
 
+    # The jobs that are returned will be locked in komrade.
+    # This ensures that no other komrade clients can view them.
+    # If you dequeue a job, it is your responsiblity to update the job.
+    # Updates to jobs include: heartbeat, fail, and delete.
+    #
+    # Moderately fast operation.
     def dequeue(opts={})
       limit = opts[:limit] || 1
-      get("/jobs?limit=#{limit}")
+      log(:at => "dequeue-job", :limit => limit) do
+        get("/jobs?limit=#{limit}")
+      end
     end
 
+    # Idempotent call to delete a job from the queue.
+    #
+    # Fast operation.
     def remove(id)
-      delete("/jobs/#{id}")
+      log(:at => "remove-job", :job => id) do
+        delete("/jobs/#{id}")
+      end
+    end
+
+    # Delete all of the jobs in a queue.
+    # Returns the count of the jobs that were deleted.
+    #
+    # Slow operation.
+    def delete_all
+      log(:at => "cleat") do
+        post("/delete-all-jobs")
+      end
+    end
+
+    private
+
+    def log(data, &blk)
+      Komrade.log(data, &blk)
     end
   end
 end

data/lib/komrade-client/tasks.rb

@@ -1,4 +1,5 @@
 require 'komrade-client/worker'
+require 'komrade-client/queue'
 
 task :environment
 
@@ -11,8 +12,8 @@ namespace :komrade do
     @worker.start
   end
 
-  desc "Returns the number of jobs in the (default or QUEUE) queue"
-  task :count => :environment do
-    $stdout.puts(Komrade::Worker.new.queue.count)
+  desc "Deletes all jobs in the queue."
+  task :delete_all => :environment do
+    $stdout.puts(Komrade::Queue.delete_all)
   end
 end

data/lib/komrade-client/worker.rb

@@ -30,12 +30,20 @@ module Komrade
       until jobs.empty?
         job = jobs.pop
         begin
+          @finished, @beats = false, 0
+          Thread.new do
+            while @beats == 0 || !@finished
+              @beats += 1
+              HttpHelpers.post("/jobs/#{job['id']}/heartbeats")
+              sleep(1)
+            end
+          end
           call(job["payload"])
+          @finished = true
         rescue => e
           handle_failure(job, e)
         ensure
           Queue.remove(job["id"])
-          log(:at => "remove-job", :job => job["id"])
         end
       end
     end
@@ -54,7 +62,7 @@ module Komrade
     # is raised during the execution of the job.
     def handle_failure(job,e)
       fid = SecureRandom.uuid
-      log(:at => "handle_failure", failure_id: fid)
+      log(:at => "handle-failure", :failure_id => fid)
       b = {error: e.class, message: e.message}
       HttpHelpers.put("/jobs/#{job['id']}/failures/#{fid}", b)
     end

data/readme.md

@@ -1,6 +1,6 @@
-# Komrade
+# Komrade Client
 
-A client library for the komrade worker queue.
+A small, Ruby superset of Komrade's [HTTP API](https://gist.github.com/4641301)
 
 ## Setup
 
@@ -16,6 +16,7 @@ $ gem install komrade-client
 1. Install Gem
 2. Enqueue
 3. Dequeue
+4. Komrade Dashboard
 
 ### Install
 
@@ -28,6 +29,14 @@ gem 'komrade-client', '1.0.1'
 
 ### Enqueue
 
+Simple Example
+
+```bash
+$ export KOMRADE_URL=https://u:p@service.komrade.io
+$ ruby -r komrade-client -e 'Komrade::Queue.enqueue("puts", "hello world")`
+$ ruby -r komrade-client -e 'puts Komrade::Queue.dequeue`
+```
+
 Example Model
 
 ```ruby
@@ -62,3 +71,12 @@ Procfile
 web: bundle exec rails s
 worker: bundle exec rake komrade:work
 ```
+
+### Komrade Dashboard
+
+```bash
+$ heroku addons:open komrade:test
+```
+
+![img](http://f.cl.ly/items/0G3f0B2J3J40451h0k3I/Screen%20Shot%202013-01-27%20at%2010.41.53%20PM.png)
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: komrade-client
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.5
   prerelease: 
 platform: ruby
 authors: