langrove-plugin-resque 0.2 → 0.3

data/Gemfile.lock

@@ -1,6 +1,6 @@
 GIT
   remote: git@github.com:cluetechnologies/langrove-enterprise.git
-  revision: ba46ec4bfd41f9c8962e6aab938c2733f4be225d
+  revision: 0fdc27f345889dabbf8df4f22a9636bf5af920d8
   branch: master
   specs:
     langrove (0.0.5.2)

data/README.md

@@ -1,7 +1,7 @@
 `Plugin::Resque`
 ===============
 
-Integrates [Resque](https://github.com/defunkt/resque/) Worker and Job functionality into LanGrove. Resque used [Redis](http://redis.io/documentation) under the hood.
+Integrates [Resque](https://github.com/defunkt/resque/) Worker and Job functionality into LanGrove. Resque uses [Redis](http://redis.io/documentation) under the hood.
 
 `gem install langrove-plugin-resque`
 
@@ -10,14 +10,20 @@ Implements
 
 * `Adaptor::ResqueAdaptor < LanGrove::Adaptor::Base` ...the worker (de-queue-er)
 * `Handler::ResqueHandler < LanGrove::Handler::Base` ...the job
-* `Plugin::ResqueQueue < LanGrove::Plugin::Deferror` ...the en-queue-er
-
+* `Plugin::ResqueQueue < LanGrove::Plugin::Enqueuer` ...the en-queue-er
 
 Supports
 --------
 
-* `LanGrove::Behaviour::Deferrable`
+* `LanGrove::Behaviour::Enqueueable`
+
+Important
+---------
 
+* Departs form traditional Resqu use.
+* Each queue has a corresponding queue_failed queue.
+* Uncaught exceptions from the Job are caught in the Worker and posted onto the _failed queue along with the original payload.
+* There is no infrastructure to resubmit.
 
 Examples
 --------
@@ -30,18 +36,26 @@ Examples
 
     :plugins:
         :a_job_queue:
-          :class: ResqueQueue
+            :class: ResqueQueue
             :job: JobName
             :queue: job_name
 
+            #
+            # Optionals (with defaults)
+            # 
+            # Refers to the redis connection
+            # 
+            :hostname: localhost
+            :port: 6397
+
   ...
 
     :server:
         :behavior:
-            :deferrable:
+            :enqueueable:
                 :plugin: :a_job_queue
                 :at:
-                    :handler_after_receive: :defer_capsule
+                    :handler_after_receive: :enqueue_capsule
                     #
                     # will post the caspsule as payload
                     # onto the specified resque queue 
@@ -61,7 +75,7 @@ Examples
 
     :adaptor:
         :class: ResqueAdaptor
-        :queue: job_name
+        :plugin: :a_job_queue
 
     ...
 
@@ -75,3 +89,18 @@ Examples
 
 </pre>
 
+
+Change Log
+----------
+
+### 2012-07-29
+
+* Added support for sharing common plugin subconfig branch
+* Added support for remote redis server.
+
+### 2012-07-31
+
+* Deferrable was renamed to enqueueable
+* v0.3
+
+

data/langrove-plugin-resque.gemspec

@@ -2,7 +2,7 @@ $LOAD_PATH.unshift 'lib'
 
 Gem::Specification.new do |spec|
   spec.name = %q{langrove-plugin-resque}
-  spec.version = '0.2' 
+  spec.version = '0.3' 
   spec.date = DateTime.now.strftime( "%Y-%m-%d" )
   spec.authors = ["Richard","","",""]
   spec.email = %q{ops@clue.co.za}

data/lib/adaptor/resque_adaptor.rb

@@ -35,24 +35,73 @@ module Adaptor
     
     def initialize(  root, config, deamon_name )
       
-      super
-      
-      @type = :not_eventmachine
-      
       raise config_exception(
 
-        "#{self.class} requires :queue:"
+        "#{self.class} requires :plugin:"
 
       ) if (
 
         config.nil? or
-        
-        not config.has_key?( :queue ) or
-        not @queue = config[ :queue ] or
-        @queue == ''
+        config[:plugin].nil?
+
+      )
+      
+      super
+
+      raise config_exception(
+
+        "#{self.class} requires :plugin: to define :queue:"
+
+      ) if (
 
+        config[:plugin][:queue].nil?
+
+      )
+
+      @queue = config[:plugin][:queue]
+
+
+      #
+      # Departure from traditional use of resque...
+      # - Each job has its own failed queue
+      # - Failed jobs are not resubmittable
+      # - The failure queue contains the exception
+      #
+
+      failed_queue = "#{@queue}_failed"
+
+      @failed_job_class = Object.const_set( failed_queue.camelize, 
+      
+        Class.new do
+          
+          self.instance_variable_set(
+          
+            :@queue, failed_queue
+          
+          )
+          
+       end
+        
       )
       
+      @hostname = config[:plugin][:hostname].nil? ? 
+
+        'localhost' : config[:plugin][:hostname]
+
+      @port = config[:plugin][:port].nil? ? 
+
+        6379 : config[:plugin][:port]
+      
+      
+      Resque.redis = Redis.new(
+
+        :host => @hostname, 
+        :port => @port
+
+      )
+
+      @type = :not_eventmachine
+
     end
     
     def connector( params, &block )
@@ -62,7 +111,7 @@ module Adaptor
       # one at a time, 
       # into the caller.
       #
- 
+
       wait_for_job( @queue, &block )
       
     end
@@ -74,21 +123,49 @@ module Adaptor
       worker = Resque::Worker.new( queue )
       
       worker.work do |job_spec|
-        
-        new_job = job_spec.payload_class.new
-        
-        new_job.payload = job_spec.payload
-        
-        #
-        # Job is yielded up the assignment pipeline to
-        # get access to all the local infrastructure.
-        #
-        
-        yield new_job
+
+        new_job = nil
+
+        begin
+
+          new_job = job_spec.payload_class.new
+          
+          new_job.payload = job_spec.payload
+          
+          #
+          # Job is yielded up the assignment pipeline to
+          # get access to all the local infrastructure.
+          #
+          
+          yield new_job if block
+
+        rescue Exception => e 
+
+          job_failed( job_spec, new_job, e )
+          
+        end
         
       end
 
     end
+
+    def job_failed( spec, job, exception )
+
+      @logger.error "JOB FAILED ~ exception: #{exception.to_s}, payload: #{spec.payload}"
+
+      @root.trigger( job, :handler, :error )
+
+      Resque.enqueue( 
+      
+          @failed_job_class, Time.now, {
+          :exception => exception.inspect,
+          :payload => spec.payload
+
+      } )
+
+      job.error( exception )
+
+    end
     
   end
   

data/lib/handler/resque_handler.rb

@@ -4,7 +4,7 @@ module Handler
     
     attr_accessor :payload
     
-    def do_work
+    def work
 
       #
       # OVERRIDE
@@ -60,28 +60,10 @@ module Handler
       
       
       #
-      # Call implementor overridable start
+      # Call implementor overridables
       #
       start
-      
-      do_work 
-      
-      
-      #
-      # Job was sent up the same assignment pipeline as
-      # socket handler, 
-      # 
-      # It has therefore been assigned into the server's
-      # @client collection
-      # 
-      # It needs to be removed
-      #
-      I.notify( @logger, "need to disconnect from server here", [:vital] )
-      #
-      # 
-      # 
-      
-      stop
+      work
       
     end
     

data/lib/plugin/resque_queue.rb

@@ -12,7 +12,7 @@
 
 module Plugin
   
-  class ResqueQueue < LanGrove::Plugin::Deferrer
+  class ResqueQueue < LanGrove::Plugin::Enqueuer
     
     def validate_config
       
@@ -48,11 +48,28 @@ module Plugin
        end
         
       )
+
+
+      @hostname = @config[:hostname].nil? ? 
+
+        'localhost' : @config[:hostname]
+
+      @port = @config[:port].nil? ? 
+
+        6379 : @config[:port]
+      
+      
+      Resque.redis = Redis.new(
+
+        :host => @hostname, 
+        :port => @port
+
+      )
       
     end
 
     
-    def defer_key( handler )
+    def enqueue_key( handler )
       
       #
       # Enqueue job with the handler.key
@@ -68,7 +85,7 @@ module Plugin
       
     end
     
-    def defer_capsule( handler )
+    def enqueue_capsule( handler )
       
       #
       # Enqueue job with the handler.capsule

data/spec/adaptor/resque_adaptor_spec.rb

@@ -3,123 +3,119 @@ require 'spec_helper'
 describe Adaptor::ResqueAdaptor do
   
   before :all do
-    
-    class FakeJob < Handler::ResqueHandler
-      
-    end
+
+    @daemon_name = 'deferror'
+    @plugin_name = :deferror
+    @queue_name = :resque_handler
     
   end
   
   
   before :each do
     
-    @queue_name = :queue_name
-    
-    @config = { 
-      
-      :queue => @queue_name 
-      
-    }
-    
-    @connect_spec = {
-      
-      :handler => {
-      
-        :class => Handler::ResqueHandler,
-      
-        :config => {}
-        
-      }
-      
+    CONFIG.plugins[@plugin_name] = {
+
+      :class => 'ResqueQueue',
+      :job => 'ResqueHandler',
+      :queue => @queue_name
+          
     }
-    
+
   end
   
   subject {
     
     Adaptor::ResqueAdaptor.new( 
     
-      ROOT, @config , nil
+      ROOT, ROOT.config[:daemons][@daemon_name][:adaptor] , nil
   
     )
     
   }
+
   
-  it 'raises on missing queue name' do
-    
-    expect {
-    
-      Adaptor::ResqueAdaptor.new(
-    
-        ROOT, { :queue => '' }, nil
-    
-      )
+  context 'raises on' do
+
+    before :each do
+
+      CONFIG.create( @daemon_name, :adaptor, 'ResqueAdaptor' )
+
+    end
+
+    it 'missing :plugin: config' do
+
+      expect {
       
-    }.to raise_error(
-    
-      LanGrove::DaemonConfigException,
+        Adaptor::ResqueAdaptor.new(
       
-      "Adaptor::ResqueAdaptor requires :queue:"
-    
-    )
+          ROOT, ROOT.config[:daemons][@daemon_name][:adaptor], nil
+      
+        )
+        
+      }.to raise_error(
+      
+        LanGrove::DaemonConfigException,
+        
+        "Adaptor::ResqueAdaptor requires :plugin:"
+      
+      )
+    end
     
   end
   
   context 'uses requeue to' do
     
     before :each do
-      
-      @parameters = {
-        
-        :handler => {
-          
-          :class => 'FakeJob'
-          
-        }
-        
-      }
-      
-      #
-      # Mock the resque infrastructure
-      #
-      
-      @worker = mock( 'Resque::Worker' )
-      
-      @job = mock( 'Job' )
-      
-      @payload = {}
-      
-      Resque::Worker.should_receive(
-      
-        :new
-      
-      ).and_return(
-      
-        @worker
-      
-      )
-      
-      @worker.should_receive( 
-      
-        :work
-      
-      ).and_yield(
-      
-        @job
-        
+
+      CONFIG.create( @daemon_name, :adaptor, 'ResqueAdaptor', {
+
+        :plugin => @plugin_name
+
+      })
+
+    end
+
+    it 'initializes redis with hostname and port' do
+
+      Redis.should_receive( 
+
+        :new).with( {:host => "localhost", :port => 6397}
+
       )
-      
-      @job.should_receive(
+
+      subject
+
+    end
+
+    it 'get jobs from a queue' do
+
+      worker = mock( 'Resque::Worker' )
+
+      job = mock( 'Resque::Job' )
+
+      Resque::Worker.should_receive( 
+
+        :new ).with( @queue_name
+
+      ).and_return( worker )
+
+      worker.should_receive( 
+
+        :work).and_yield( job
+
+      )   
+     
+      job.should_receive(
       
         :payload_class
       
       ).and_return(
       
-        FakeJob
+        Handler::ResqueHandler
       
       )
-      
-      @job.should_receive(
+
+      job.should_receive(
       
         :payload
         
@@ -128,23 +124,19 @@ describe Adaptor::ResqueAdaptor do
         @payload
         
       )
-      
-    end
-  
-    it 'yields jobs' do
-      
+
       job = nil
-      
-      subject.connector( @parameters ) do |new_job|
-        
-        job = new_job
-        
+     
+      subject.connector( {} ) do |next_job|
+
+        job = next_job
+
       end
-      
-      job.should be_a( FakeJob )
-      
+
+      job.should be_a( Handler::ResqueHandler )
+
     end
-  
+
   end
   
 end

data/spec/spec_helper.rb

@@ -1,12 +1,7 @@
 require 'langrove-plugin-resque'
 
-RESQUE_DEFERRER = {
-
-  :class => 'ResqueQueue',
-  :job => 'ResqueWorker',
-  :queue => :resque_queue
-      
-}
-
-ROOT = LanGrove::FakeRoot.new
+RESQUE_DEFERRER = 
 
+CONFIG = LanGrove::FakeConfig.new
+LOG = LanGrove::FakeLogger
+ROOT = LanGrove::Root::Base.new( nil, LOG, CONFIG )

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: langrove-plugin-resque
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-29 00:00:00.000000000 Z
+date: 2012-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: langrove