komrade-client 1.0.6 → 1.0.15

data/lib/komrade-client.rb

@@ -1,8 +1,10 @@
 require 'uri'
+require 'thread'
 
 module Komrade
   extend self
   Error = Class.new(StandardError)
+  @outLocker = Mutex.new
 
   def env(key)
     ENV[key]
@@ -25,16 +27,25 @@ module Komrade
     if block_given?
       start = Time.now
       result = yield
-      data.merge!(val: (Time.now - start))
+      data.merge!(:val => (Time.now - start))
     end
     data.reduce(out=String.new) do |s, tup|
       s << [tup.first, tup.last].join("=") << " "
     end
-    $stdout.puts(out)
+    @outLocker.synchronize do
+      $stdout.puts(out)
+    end
     return result
   end
 
 end
 
 require 'komrade-client/queue'
-require 'komrade-client/railtie' if defined?(Rails)
+
+if defined?(Rails)
+  require 'rails/railtie'
+  require 'komrade-client/railtie'
+
+  require 'rails/generators/base'
+  require 'komrade-client/komrade_generator'
+end

data/lib/komrade-client/http_helpers.rb

@@ -70,7 +70,7 @@ module Komrade
       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
+          h.verify_mode = OpenSSL::SSL::VERIFY_PEER
         end
       end
     end

data/lib/komrade-client/komrade_generator.rb

@@ -0,0 +1,9 @@
+class KomradeGenerator < Rails::Generators::Base
+  desc "This generator adds a komrade-worker process to your Procfile"
+  def append_procfile
+    File.open("Procfile", 'ab') do |file|
+      file.write("komrade-worker: bundle exec rake komrade:work")
+    end
+    puts "A worker process has been added to your Procfile you will be billed accordingly."
+  end
+end

data/lib/komrade-client/queue.rb

@@ -12,7 +12,7 @@ module Komrade
     # Fast operation.
     def enqueue(method, *args)
       SecureRandom.uuid.tap do |id|
-        log(:at => "enqueue-job", :job => id, :method => method) do
+        log(:at => "enqueue-job", :id => id, :method => method) do
           put("/jobs/#{id}", method: method, args: args)
         end
       end
@@ -23,19 +23,21 @@ module Komrade
     # If you dequeue a job, it is your responsiblity to update the job.
     # Updates to jobs include: heartbeat, fail, and delete.
     #
+    # There is no logging for dequeue since this method will be called
+    # frequently. Instead, logging should happen in the caller of
+    # dequeue to inform the stream that a job was locked.
+    #
     # Moderately fast operation.
     def dequeue(opts={})
       limit = opts[:limit] || 1
-      log(:at => "dequeue-job", :limit => limit) do
-        get("/jobs?limit=#{limit}")
-      end
+      get("/jobs?limit=#{limit}")
     end
 
     # Idempotent call to delete a job from the queue.
     #
     # Fast operation.
     def remove(id)
-      log(:at => "remove-job", :job => id) do
+      log(:at => "remove-job", :id => id) do
         delete("/jobs/#{id}")
       end
     end
@@ -45,7 +47,7 @@ module Komrade
     #
     # Slow operation.
     def delete_all
-      log(:at => "cleat") do
+      log(:at => "delete-all") do
         post("/delete-all-jobs")
       end
     end

data/lib/komrade-client/worker.rb

@@ -25,23 +25,33 @@ module Komrade
     # This method will lock a job & evaluate the code defined by the job.
     # Also, this method will make the best attempt to delete the job
     # from the queue before returning.
+    #
+    # Before the worker evaluates the code extracted from the job,
+    # it spawns a thread which will send heartbeats to komrade. This
+    # indicates to the back end that the job is being processed. If heartbeats
+    # stop coming in for a job, komrade may thing that the job is lost and
+    # subsequently release the lock and place it back in the queue.
     def work
       jobs = Queue.dequeue
       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)
+          log(:at => "work-job", :id => job['id']) do
+            @finished, @beats = false, 0
+            Thread.new do
+              while @beats == 0 || !@finished
+                @beats += 1
+                log(:at => "heartbeat-job", :id => job['id'])
+                HttpHelpers.post("/jobs/#{job['id']}/heartbeats")
+                sleep(1)
+              end
             end
+            call(job["payload"])
+            @finished = true
           end
-          call(job["payload"])
-          @finished = true
         rescue => e
           handle_failure(job, e)
+          raise(e)
         ensure
           Queue.remove(job["id"])
         end
@@ -62,13 +72,13 @@ 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", :id => job['id'], 'failure-id' => fid)
       b = {error: e.class, message: e.message}
       HttpHelpers.put("/jobs/#{job['id']}/failures/#{fid}", b)
     end
 
-    def log(data)
-      Komrade.log(data)
+    def log(data, &blk)
+      Komrade.log(data, &blk)
     end
 
   end

data/readme.md

@@ -14,30 +14,46 @@ $ gem install komrade-client
 ## Usage
 
 1. Install Gem
-2. Enqueue
-3. Dequeue
+2. Minimalist Example
+3. Rails Example
 4. Komrade Dashboard
 
-### Install
+### Install Gem
 
 Gemfile
 
 ```ruby
 source :rubygems
-gem 'komrade-client', '1.0.6'
+gem 'komrade-client', '~> 1.0.15'
 ```
 
-### Enqueue
+### Minimalist Example ###
 
-Simple Example
+This is the absolute bare minimum to see Komrade in action.
 
 ```bash
-$ export KOMRADE_URL=https://u:p@service.komrade.io
+$ export KOMRADE_URL=https://{heroku_username}:{heroku_password}@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
+You should see "hello world" output in your terminal.
+
+### Rails Example ###
+
+To get started add  `gem 'komrade-client', '~> 1.0.15'` to your Gemfile. Then run
+`rails g komrade`. This will add a komrade-worker process to your Procfile (feel
+free to edit your Procfile by hand if you prefer).
+
+Your Procfile now should look something like this:
+```
+web: bundle exec rails s
+komrade-worker: bundle exec rake komrade:work
+```
+
+This is an example of a Rails model that sends a welcome email upon user sign up.
+The only code that is unique to Komrade here is the `Komrade::Queue.enqueue` method.
+This method takes a method as a string and any parameters you want to pass to that method.
 
 ```ruby
 
@@ -56,14 +72,9 @@ class User < ActiveRecord::Base
 end
 ```
 
-### Dequeue
-
-Procfile
+When you deploy your code, the will queue be ready to accept jobs, and the worker process
+is waiting to do the work.
 
-```
-web: bundle exec rails s
-worker: bundle exec rake komrade:work
-```
 
 ### Komrade Dashboard
 
@@ -72,4 +83,3 @@ $ 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.6
+  version: 1.0.15
   prerelease: 
 platform: ruby
 authors:
@@ -11,13 +11,14 @@ bindir: bin
 cert_chain: []
 date: 2013-01-26 00:00:00.000000000 Z
 dependencies: []
-description: A client library for the komrad worker queue.
+description: A client library for the komrade worker queue.
 email: komrade@32k.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/komrade-client/http_helpers.rb
+- lib/komrade-client/komrade_generator.rb
 - lib/komrade-client/queue.rb
 - lib/komrade-client/railtie.rb
 - lib/komrade-client/rate_limiter.rb