rabbit_jobs 0.0.3 → 0.0.4

data/examples/configuration.rb

@@ -17,6 +17,13 @@ puts JSON.pretty_generate(RabbitJobs.config.to_hash)
 
 puts JSON.pretty_generate(RabbitJobs.config.queues)
 
-# 10.times {
-  RabbitJobs.enqueue_to('rabbit_jobs_test1', Integer, 'to_s')
-# }
+class MyJob < RabbitJobs::Job
+
+  expires_in 60 # dont perform this job after 60 seconds
+
+  def self.perform(time)
+    puts "This job was published at #{}"
+  end
+end
+
+RabbitJobs.publish_to('rabbit_jobs_test1', MyJob, Time.now)

data/lib/rabbit_jobs/configuration.rb

@@ -72,7 +72,7 @@ module RabbitJobs
     def exchange(value = nil, params = {})
       if value
         raise ArgumentError unless value.is_a?(String) && value != ""
-        @data[:exchange] = value
+        @data[:exchange] = value.downcase
         @data[:exchange_params] = DEFAULT_EXCHANGE_PARAMS.merge(params)
       else
         @data[:exchange]
@@ -83,6 +83,8 @@ module RabbitJobs
       raise ArgumentError.new("name is #{name.inspect}") unless name && name.is_a?(String) && name != ""
       raise ArgumentError.new("params is #{params.inspect}") unless params && params.is_a?(Hash)
 
+      name = name.downcase
+
       if @data[:queues][name]
         @data[:queues][name].merge!(params)
       else

data/lib/rabbit_jobs/job.rb

@@ -1,37 +1,33 @@
 # -*- encoding : utf-8 -*-
 require 'json'
+require 'digest/md5'
 
-module RabbitJobs
-  class Job
-    include RabbitJobs::Helpers
-    include Logger
-
-    attr_accessor :params, :klass, :child
-
-    def initialize(payload)
-      begin
-        self.params = JSON.parse(payload)
-        klass_name = params.delete_at(0)
-        self.klass = constantize(klass_name)
-      rescue
-        log "JOB INIT ERROR at #{Time.now.to_s}:"
-        log $!.inspect
-        log $!.backtrace
-        log "message: #{payload.inspect}"
-        # Mailer.send(klass_name, params, $!)
-      end
+module RabbitJobs::Job
+  extend RabbitJobs::Helpers
+  extend RabbitJobs::Logger
+  extend self
+
+  def self.included(base)
+    include RabbitJobs::Logger
+    base.extend (ClassMethods)
+
+    def initialize(*perform_params)
+      self.params = *perform_params
+      self.opts = {}
     end
 
-    def perform
-      if @child = fork
+    attr_accessor :params, :opts, :child_pid
+
+    def run_perform
+      if @child_pid = fork
         srand # Reseeding
-        log! "Forked #{@child} at #{Time.now} to process #{klass}.perform(#{ params.map(&:inspect).join(', ') })"
-        Process.wait(@child)
+        log "Forked #{@child_pid} at #{Time.now} to process #{self.class}.perform(#{ params.map(&:inspect).join(', ') })"
+        Process.wait(@child_pid)
         yield if block_given?
       else
         begin
           # log 'before perform'
-          klass.perform(*params)
+          self.class.perform(*params)
           # log 'after perform'
         rescue
           puts $!.inspect
@@ -39,5 +35,54 @@ module RabbitJobs
         exit!
       end
     end
+
+    def payload
+      {'class' => self.class.to_s, 'opts' => (self.opts || {}), 'params' => params}.to_json
+      # ([self.class.to_s] + params).to_json
+    end
+
+    def expires_in
+      self.class.rj_expires_in
+    end
+
+    def expires?
+      !!self.expires_in
+    end
+
+    def expired?
+      if self.opts['expires_at']
+        Time.now > Time.new(opts['expires_at'])
+      elsif expires? && opts['created_at']
+        Time.now > (Time.new(opts['created_at']) + expires_in)
+      else
+        false
+      end
+    end
+  end
+
+  module ClassMethods
+    attr_accessor :rj_expires_in
+
+    # DSL method for jobs
+    def expires_in(seconds)
+     @rj_expires_in = seconds
+    end
+  end
+
+  def self.parse(payload)
+    begin
+      encoded = JSON.parse(payload)
+      job_klass = constantize(encoded['class'])
+      job = job_klass.new(*encoded['params'])
+      job.opts = encoded['opts']
+      job
+    rescue
+      log "JOB INIT ERROR at #{Time.now.to_s}:"
+      log $!.inspect
+      log $!.backtrace
+      log "message: #{payload.inspect}"
+      # Mailer.send(klass_name, params, $!)
+      # raise $!
+    end
   end
 end

data/lib/rabbit_jobs/publisher.rb

@@ -9,37 +9,35 @@ module RabbitJobs
     extend self
     extend AmqpHelpers
 
-    def enqueue(klass, *params)
+    def publish(klass, opts = {}, *params)
       key = RabbitJobs.config.routing_keys.first
-      enqueue_to(key, klass, *params)
+      publish_to(key, klass, opts, *params)
     end
 
-    def enqueue_to(routing_key, klass, *params)
+    def publish_to(routing_key, klass, opts = {}, *params)
       raise ArgumentError unless klass && routing_key
+      opts ||= {}
 
-      payload = ([klass.to_s] + params).to_json
+      job = klass.new(*params)
+      job.opts = opts
 
+      publish_job_to(routing_key, job)
+    end
+
+    def publish_job_to(routing_key, job)
       amqp_with_exchange do |connection, exchange|
 
         queue = make_queue(exchange, routing_key)
 
-        exchange.publish(payload, Configuration::DEFAULT_MESSAGE_PARAMS.merge({routing_key: routing_key})) {
+        job.opts['created_at'] = Time.now.to_s
+
+        payload = job.payload
+        exchange.publish(job.payload, Configuration::DEFAULT_MESSAGE_PARAMS.merge({routing_key: routing_key})) {
           connection.close { EM.stop }
         }
       end
     end
 
-    # def spam
-    #   payload = ([klass.to_s] + params).to_json
-
-    #   amqp_with_exchange do |connection, exchange|
-    #     10000.times { |i| RabbitJobs.enqueue(RabbitJobs::TestJob, i) }
-    #     exchange.publish(payload, RabbitJobs.config.publish_params.merge({routing_key: routing_key})) {
-    #       connection.close { EM.stop }
-    #     }
-    #   end
-    # end
-
     def purge_queue(routing_key)
       raise ArgumentError unless routing_key
 

data/lib/rabbit_jobs/tasks.rb

@@ -12,21 +12,15 @@ namespace :rj do
 
     begin
       worker = RabbitJobs::Worker.new(*queues)
+      worker.pidfile = ENV['PIDFILE']
+      worker.background = %w(yes true).include? ENV['BACKGROUND']
       RabbitJobs::Logger.verbose = true if ENV['VERBOSE']
       # worker.very_verbose = ENV['VVERBOSE']
     end
 
-    if ENV['BACKGROUND']
-      Process.daemon(true)
-    end
-
-    if ENV['PIDFILE']
-      File.open(ENV['PIDFILE'], 'w') { |f| f << worker.pid }
-    end
-
     # worker.log "Starting worker #{worker.pid}"
     # worker.verbose = true
-    worker.work 1
+    worker.work 10
     # worker.work(ENV['INTERVAL'] || 5) # interval, will block
   end
 

data/lib/rabbit_jobs/version.rb

@@ -1,3 +1,3 @@
 module RabbitJobs
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/rabbit_jobs/worker.rb

@@ -5,6 +5,8 @@ module RabbitJobs
     include AmqpHelpers
     include Logger
 
+    attr_accessor :pidfile, :background
+
     # Workers should be initialized with an array of string queue
     # names. The order is important: a Worker will check the first
     # queue given for a job. If none is found, it will check the
@@ -28,7 +30,7 @@ module RabbitJobs
     end
 
     # Subscribes to channel and working on jobs
-    def work(time = 10)
+    def work(time = 0)
       startup
 
       processed_count = 0
@@ -39,7 +41,11 @@ module RabbitJobs
           if @shutdown
             log "Processed jobs: #{processed_count}"
             log "Stopping worker..."
-            connection.close { EM.stop { exit! } }
+
+            connection.close {
+              File.delete(self.pidfile) if self.pidfile
+              EM.stop { exit! }
+            }
           end
         }
 
@@ -49,16 +55,19 @@ module RabbitJobs
           log "Worker ##{Process.pid} <= #{exchange.name}##{routing_key}"
 
           queue.subscribe(ack: true) do |metadata, payload|
-            @job = Job.new(payload)
-            @job.perform
+            @job = RabbitJobs::Job.parse(payload)
+            @job.run_perform unless @job.expired?
             metadata.ack
             processed_count += 1
             check_shutdown.call
           end
         end
 
-        EM.add_timer(time) do
-          self.shutdown
+        if time > 0
+          # for debugging
+          EM.add_timer(time) do
+            self.shutdown
+          end
         end
 
         EM.add_periodic_timer(1) do
@@ -74,6 +83,12 @@ module RabbitJobs
     def startup
       # prune_dead_workers
 
+      Process.daemon(true) if self.background
+
+      if self.pidfile
+        File.open(self.pidfile, 'w') { |f| f << Process.pid }
+      end
+
       # Fix buffering so we can `rake rj:work > resque.log` and
       # get output from the child in there.
       $stdout.sync = true
@@ -90,10 +105,10 @@ module RabbitJobs
     end
 
     def kill_child
-      if @job && @job.child
+      if @job && @job.child_pid
         # log! "Killing child at #{@child}"
-        if Kernel.system("ps -o pid,state -p #{@job.child}")
-          Process.kill("KILL", @job.child) rescue nil
+        if Kernel.system("ps -o pid,state -p #{@job.child_pid}")
+          Process.kill("KILL", @job.child_pid) rescue nil
         else
           # log! "Child #{@child} not found, restarting."
           # shutdown

data/lib/rabbit_jobs.rb

@@ -14,23 +14,11 @@ require 'rabbit_jobs/worker'
 module RabbitJobs
   extend self
 
-  def enqueue(klass, *params)
-    RabbitJobs::Publisher.enqueue(klass, *params)
+  def publish(klass, opts = {}, *params)
+    RabbitJobs::Publisher.publish(klass, opts, *params)
   end
 
-  def enqueue_to(routing_key, klass, *params)
-    RabbitJobs::Publisher.enqueue_to(routing_key, klass, *params)
-  end
-
-  class TestJob < RabbitJobs::Job
-    def self.perform(*params)
-      # puts "processing in job: " + params.inspect
-      # sleep 0.1
-
-      # if rand(3) == 0
-      #   puts "ERROR TEXT"
-      #   raise "ERROR TEXT"
-      # end
-    end
+  def publish_to(routing_key, klass, opts = {}, *params)
+    RabbitJobs::Publisher.publish_to(routing_key, klass, opts, *params)
   end
 end

data/rabbit_jobs.gemspec

@@ -18,4 +18,5 @@ Gem::Specification.new do |gem|
   gem.version       = RabbitJobs::VERSION
 
   gem.add_dependency "amqp", "~> 0.9"
+  gem.add_dependency "rake"
 end

data/spec/fixtures/jobs.rb

@@ -0,0 +1,29 @@
+# -*- encoding : utf-8 -*-
+
+class TestJob
+  include RabbitJobs::Job
+end
+
+class PrintTimeJob
+  include RabbitJobs::Job
+
+  def self.perform(time)
+    puts "Running job queued at #{time}"
+  end
+end
+
+class JobWithExpire
+  include RabbitJobs::Job
+  expires_in 60*60 # expires in 1 hour
+  def self.perform
+
+  end
+end
+
+class ExpiredJob
+  include RabbitJobs::Job
+
+  def self.perform
+
+  end
+end

data/spec/integration/publisher_spec.rb

@@ -3,15 +3,17 @@ require 'spec_helper'
 require 'json'
 
 describe RabbitJobs::Publisher do
-  it 'should publish message to queue' do
 
+  before(:each) do
+    queue_name = 'test'
     RabbitJobs.configure do |c|
-      # c.host "somehost.lan"
-      c.exchange 'test', auto_delete: true
-      c.queue 'rspec_queue', auto_delete: true
+      c.exchange 'test'
+      c.queue 'rspec_queue'
     end
+  end
 
-    RabbitJobs.enqueue(Integer, 'some', 'other', 'params')
+  it 'should publish message to queue' do
+    RabbitJobs.publish(TestJob, nil, 'some', 'other', 'params')
     RabbitJobs::Publisher.purge_queue('rspec_queue').should == 1
   end
 end

data/spec/integration/worker_spec.rb

@@ -0,0 +1,18 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+require 'eventmachine'
+describe RabbitJobs::Worker do
+  it 'should listen for messages' do
+    RabbitJobs.configure do |c|
+      c.exchange 'test_durable', auto_delete: false, durable: true
+      c.queue 'rspec_durable_queue', auto_delete: false, durable: true, ack: true
+    end
+
+    5.times { RabbitJobs.publish(PrintTimeJob, nil, Time.now) }
+    5.times { RabbitJobs.publish(ExpiredJob, { :expires_at => Time.now - 10 }) }
+    worker = RabbitJobs::Worker.new
+
+    worker.work(1) # work for 1 second
+  end
+end

data/spec/spec_helper.rb

@@ -1,13 +1,15 @@
 # -*- encoding : utf-8 -*-
 require 'simplecov'
-SimpleCov.start {
-  add_filter "spec" # ignore gems
-}
+SimpleCov.start do
+  add_filter "spec" # ignore spec files
+end
 
 require 'rr'
 
 require 'rabbit_jobs'
 
+require 'fixtures/jobs'
+
 RSpec.configure do |config|
   config.mock_with :rr
   # or if that doesn't work due to a version incompatibility

data/spec/unit/job_spec.rb

@@ -0,0 +1,29 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+describe RabbitJobs::Job do
+  it 'should parse class and params' do
+    job = RabbitJobs::Job.parse({class: 'TestJob', params: [1,2,3]}.to_json)
+    job.params.should == [1, 2, 3]
+  end
+
+  it 'should understand expires_in' do
+    job = JobWithExpire.new(1, 2, 3)
+    job.expires_in.should == 60*60
+    job.expires?.should == true
+  end
+
+  context 'job expiration' do
+    it 'should expire job by expires_in option' do
+      job = TestJob.new
+      job.opts['expires_at'] = (Time.now - 10).to_s
+      job.expired?.should == true
+    end
+
+    it 'should expire job by expires_in option in job class and current_time' do
+      job = JobWithExpire.new(1, 2, 3)
+      job.opts['created_at'] = (Time.now - job.expires_in - 10).to_s
+      job.expired?.should == true
+    end
+  end
+end

data/spec/unit/rabbit_jobs_spec.rb

@@ -1,11 +1,11 @@
 # -*- encoding : utf-8 -*-
 
 describe RabbitJobs do
-  it 'should pass enqueue methods to publisher' do
-    mock(RabbitJobs::Publisher).enqueue(Integer, 1, 2, "string")
-    RabbitJobs.enqueue(Integer, 1, 2, "string")
+  it 'should pass publish methods to publisher' do
+    mock(RabbitJobs::Publisher).publish(TestJob, nil, 1, 2, "string")
+    RabbitJobs.publish(TestJob, nil, 1, 2, "string")
 
-    mock(RabbitJobs::Publisher).enqueue_to('default_queue', Integer, 1, 2, "string")
-    RabbitJobs.enqueue_to('default_queue', Integer, 1, 2, "string")
+    mock(RabbitJobs::Publisher).publish_to('default_queue', TestJob, nil, 1, 2, "string")
+    RabbitJobs.publish_to('default_queue', TestJob, nil, 1, 2, "string")
   end
 end

data/spec/unit/worker_spec.rb

@@ -11,7 +11,7 @@ describe RabbitJobs::Worker do
       @worker.queues.should == ['default']
     end
 
-    it '#startup' do
+    it '#startup should set @shutdown to false' do
       @worker.instance_variable_get('@shutdown').should_not == true
 
       mock(Signal).trap('TERM')
@@ -22,6 +22,17 @@ describe RabbitJobs::Worker do
       @worker.instance_variable_get('@shutdown').should_not == true
     end
 
+    it '#startup should write process id to file' do
+      mock(Signal).trap('TERM')
+      mock(Signal).trap('INT')
+
+      filename = 'test_worker.pid'
+      mock(File).open(filename, 'w') {}
+      @worker.pidfile = filename
+      @worker.startup
+      @worker.pidfile.should == filename
+    end
+
     it '#shutdown should set @shutdown to true' do
       @worker.instance_variable_get('@shutdown').should_not == true
       @worker.shutdown
@@ -36,8 +47,8 @@ describe RabbitJobs::Worker do
     end
 
     it '#kill_child' do
-      job = RabbitJobs::Job.new(['RabbitJobs'].to_json)
-      job.instance_variable_set '@child', 123123
+      job = TestJob.new()
+      job.instance_variable_set '@child_pid', 123123
       @worker.instance_variable_set('@job', job)
 
       mock(Kernel).system("ps -o pid,state -p #{123123}") { true }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rabbit_jobs
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-27 00:00:00.000000000 Z
+date: 2012-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amqp
-  requirement: &70147046160300 !ruby/object:Gem::Requirement
+  requirement: &70340051105620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,18 @@ dependencies:
         version: '0.9'
   type: :runtime
   prerelease: false
-  version_requirements: *70147046160300
+  version_requirements: *70340051105620
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70340051105000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70340051105000
 description: Background jobs on RabbitMQ
 email:
 - lazureykis@gmail.com
@@ -49,9 +60,12 @@ files:
 - lib/tasks/rabbit_jobs.rake
 - rabbit_jobs.gemspec
 - spec/fixtures/config.yml
+- spec/fixtures/jobs.rb
 - spec/integration/publisher_spec.rb
+- spec/integration/worker_spec.rb
 - spec/spec_helper.rb
 - spec/unit/configuration_spec.rb
+- spec/unit/job_spec.rb
 - spec/unit/logger_spec.rb
 - spec/unit/rabbit_jobs_spec.rb
 - spec/unit/worker_spec.rb
@@ -81,9 +95,12 @@ specification_version: 3
 summary: Background jobs on RabbitMQ
 test_files:
 - spec/fixtures/config.yml
+- spec/fixtures/jobs.rb
 - spec/integration/publisher_spec.rb
+- spec/integration/worker_spec.rb
 - spec/spec_helper.rb
 - spec/unit/configuration_spec.rb
+- spec/unit/job_spec.rb
 - spec/unit/logger_spec.rb
 - spec/unit/rabbit_jobs_spec.rb
 - spec/unit/worker_spec.rb