rabbit_jobs 0.11.5 → 0.12.0

data/lib/rabbit_jobs/tasks.rb

@@ -2,15 +2,15 @@ require 'rabbit_jobs'
 require 'rake'
 
 def rails_env
-  $my_rails_env ||= defined?(Rails) ? Rails.env : (ENV['RAILS_ENV'] || 'development')
+  defined?(Rails) ? Rails.env : (ENV['RAILS_ENV'] || 'development')
 end
 
 def app_root
-  $my_rails_root ||= Pathname.new(ENV['RAILS_ROOT'] || Rails.root)
+  Pathname.new(ENV['RAILS_ROOT'] || Rails.root)
 end
 
 def make_dirs
-  ["log", "tmp", "tmp/pids"].each do |subdir|
+  %w(log tmp tmp/pids).each do |subdir|
     dir = app_root.join(subdir)
     Dir.mkdir(dir) unless File.directory?(dir)
   end
@@ -21,9 +21,9 @@ namespace :rj do
     Rails.application.require_environment! if defined?(Rails)
   end
 
-  desc "Start a Rabbit Jobs worker"
-  task :worker => :environment do
-    queues = (ENV['QUEUES'] || ENV['QUEUE'] || "").split(',')
+  desc 'Starts a Rabbit Jobs worker'
+  task worker: :environment do
+    queues = (ENV['QUEUES'] || ENV['QUEUE'] || '').split(',')
     make_dirs
     worker = RJ::Worker.new(*queues)
     worker.consumer = RJ::Consumer.const_get(ENV['CONSUMER'].classify).new if ENV['CONSUMER']
@@ -31,11 +31,11 @@ namespace :rj do
     exit(worker.work)
   end
 
-  desc "Start a Rabbit Jobs scheduler"
+  desc 'Starts a Rabbit Jobs scheduler'
   task :scheduler do
     make_dirs
     scheduler = RabbitJobs::Scheduler.new
     scheduler.process_name = "rj_scheduler #{rails_env}"
     exit(scheduler.work)
   end
-end
+end

data/lib/rabbit_jobs/version.rb

@@ -1,5 +1,3 @@
-# -*- encoding : utf-8 -*-
-
 module RabbitJobs
-  VERSION = "0.11.5"
+  VERSION = '0.12.0'
 end

data/lib/rabbit_jobs/worker.rb

@@ -1,32 +1,22 @@
-# -*- encoding : utf-8 -*-
+require 'rabbit_jobs/amqp_transport'
 
 module RabbitJobs
+  # Worker daemon.
   class Worker
     include MainLoop
 
+    delegate :amqp_connection, :consumer_channel, :amqp_cleanup, to: RabbitJobs::AmqpTransport
+
     attr_accessor :process_name
     attr_reader :consumer
 
     def consumer=(value)
-      raise ArgumentError.new("value=#{value.inspect}") unless value.respond_to?(:process_message)
+      unless value.respond_to?(:process_message)
+        fail ArgumentError, 'value must implement #process_message'
+      end
       @consumer = value
     end
 
-    def amqp_connection
-      Thread.current[:rj_worker_connection] ||= Bunny.new(RabbitJobs.config.server, automatically_recover: false,
-        properties: Bunny::Session::DEFAULT_CLIENT_PROPERTIES.merge(product: "rj_worker #{Process.pid}")).start
-    end
-
-    def amqp_channel
-      @amqp_channel ||= amqp_connection.create_channel
-    end
-
-    def self.cleanup
-      conn = Thread.current[:rj_worker_connection]
-      conn.close if conn && conn.status != :not_connected
-      Thread.current[:rj_worker_connection] = nil
-    end
-
     def queue_params(routing_key)
       RJ.config[:queues][routing_key.to_sym]
     end
@@ -47,7 +37,8 @@ module RabbitJobs
       if @queues == ['*'] || @queues.empty?
         @queues = RabbitJobs.config.routing_keys
       end
-      raise "Cannot initialize worker without queues." if @queues.empty?
+
+      fail 'Cannot initialize worker without queues.' if @queues.empty?
     end
 
     def queues
@@ -55,26 +46,26 @@ module RabbitJobs
     end
 
     # Subscribes to queue and working on jobs
-    def work(time = -1)
+    def work
       return false unless startup
       @consumer ||= RJ::Consumer::JobConsumer.new
 
-      $0 = self.process_name || "rj_worker (#{queues.join(', ')})"
+      $0 = process_name || "rj_worker (#{queues.join(', ')})"
 
       @processed_count = 0
 
       begin
-        amqp_channel.prefetch(1)
+        consumer_channel.prefetch(1)
 
         queues.each do |routing_key|
           consume_queue(routing_key)
         end
 
-        RJ.logger.info "Started."
+        RJ.logger.info 'Started.'
 
-        return main_loop(time) {
+        return main_loop do
           RJ.logger.info "Processed jobs: #{@processed_count}."
-        }
+        end
       rescue
         log_daemon_error($!)
       end
@@ -82,29 +73,19 @@ module RabbitJobs
       true
     end
 
-    def startup
-      count = RJ._run_after_fork_callbacks
-
-      $stdout.sync = true
-
-      @shutdown = false
-
-      Signal.trap('TERM') { shutdown }
-      Signal.trap('INT')  { shutdown! }
-
-      true
-    end
-
     private
 
     def consume_message(delivery_info, properties, payload)
-      if (RJ.run_before_process_message_callbacks rescue nil)
+      if RJ.run_before_process_message_callbacks
         begin
           @consumer.process_message(delivery_info, properties, payload)
           @processed_count += 1
         rescue ScriptError, StandardError
-          RabbitJobs.logger.error(short_message: $!.message,
-            _payload: payload, _exception: $!.class, full_message: $!.backtrace.join("\r\n"))
+          RabbitJobs.logger.error(
+            short_message: $!.message,
+            _payload: payload,
+            _exception: $!.class,
+            full_message: $!.backtrace.join("\r\n"))
         end
         true
       else
@@ -117,16 +98,16 @@ module RabbitJobs
       RJ.logger.info "Subscribing to #{routing_key}"
       routing_key = routing_key.to_sym
 
-      queue = amqp_channel.queue(routing_key, queue_params(routing_key))
+      queue = consumer_channel.queue(routing_key, queue_params(routing_key))
 
-      explicit_ack = !!queue_params(routing_key)[:ack]
+      explicit_ack = queue_params(routing_key)[:manual_ack].present?
 
-      queue.subscribe(ack: explicit_ack) do |delivery_info, properties, payload|
+      queue.subscribe(manual_ack: explicit_ack) do |delivery_info, properties, payload|
         if consume_message(delivery_info, properties, payload)
-          amqp_channel.ack(delivery_info.delivery_tag) if explicit_ack
+          consumer_channel.ack(delivery_info.delivery_tag) if explicit_ack
         else
           requeue = false
-          amqp_channel.nack(delivery_info.delivery_tag, requeue) if explicit_ack
+          consumer_channel.nack(delivery_info.delivery_tag, requeue) if explicit_ack
         end
       end
     end

data/lib/tasks/rabbit_jobs.rake

@@ -1,2 +1,2 @@
 $LOAD_PATH.unshift File.dirname(__FILE__) + '/../../lib'
-require 'rabbit_jobs/tasks'
+require 'rabbit_jobs/tasks'

data/rabbit_jobs.gemspec

@@ -1,33 +1,34 @@
-$:.push File.expand_path("../lib", __FILE__)
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'rabbit_jobs/version'
 
 Gem::Specification.new do |spec|
-  spec.authors       = ["Pavel Lazureykis"]
-  spec.email         = ["lazureykis@gmail.com"]
-  spec.description   = %q{Background jobs on RabbitMQ}
-  spec.summary       = %q{Background jobs on RabbitMQ}
-  spec.homepage      = ""
+  spec.authors       = ['Pavel Lazureykis']
+  spec.email         = ['lazureykis@gmail.com']
+  spec.description   = 'Background jobs on RabbitMQ'
+  spec.summary       = 'Background jobs on RabbitMQ'
+  spec.homepage      = ''
   spec.date          = Time.now.strftime('%Y-%m-%d')
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.name          = "rabbit_jobs"
-  spec.require_paths = ["lib"]
+  spec.test_files    = spec.files.grep(/^spec/)
+  spec.name          = 'rabbit_jobs'
+  spec.require_paths = ['lib']
   spec.version       = RabbitJobs::VERSION
-  spec.license       = "MIT"
+  spec.license       = 'MIT'
 
-  spec.add_dependency "bunny", "~> 1.0"
-  spec.add_dependency "rake"
-  spec.add_dependency "rufus-scheduler", "~> 3.0"
-  spec.add_dependency "activesupport", "~> 4.0"
+  spec.add_dependency 'bunny', '~> 1.6.0'
+  spec.add_dependency 'rake'
+  spec.add_dependency 'rufus-scheduler', '~> 3.0'
+  spec.add_dependency 'activesupport', '~> 4.0'
 
-  spec.add_development_dependency "bundler"
+  spec.add_development_dependency 'bundler'
   # spec.add_development_dependency "rake"
-  spec.add_development_dependency "timecop"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "rr"
-  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rr'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'codeclimate-test-reporter'
 end

data/spec/fixtures/config.yml

@@ -4,10 +4,10 @@ rabbit_jobs:
     durable_queue:
       durable: true
       auto_delete: false
-      ack: true
+      manual_ack: true
       arguments:
         x-ha-policy: all
     fast_queue:
       durable: false
       auto_delete: true
-      ack: false
+      manual_ack: false

data/spec/fixtures/jobs.rb

@@ -1,5 +1,3 @@
-# -*- encoding : utf-8 -*-
-
 class TestJob
   include RJ::Job
   def perform
@@ -16,7 +14,7 @@ end
 
 class JobWithExpire
   include RJ::Job
-  expires_in 60*60 # expires in 1 hour
+  expires_in 1.hour
   def perform
 
   end

data/spec/integration/publisher_spec.rb

@@ -17,33 +17,54 @@ describe RabbitJobs::Publisher do
 
   it 'should publish message to queue' do
     RJ.publish_to(:rspec_queue, TestJob, 'some', 'other', 'params')
-    RJ.purge_queue('rspec_queue').should == 1
+    RJ.queue_status('rspec_queue')[:message_count].to_i.should == 1
+    RJ.purge_queue('rspec_queue')
+    RJ.queue_status('rspec_queue')[:message_count].to_i.should == 0
   end
 
   it 'should accept symbol as queue name' do
     RJ.publish_to(:rspec_queue, TestJob)
-    RJ.purge_queue('rspec_queue').should == 1
+    RJ.queue_status('rspec_queue')[:message_count].to_i.should == 1
+    RJ.purge_queue('rspec_queue')
+    RJ.queue_status('rspec_queue')[:message_count].to_i.should == 0
   end
 
   it 'purge_queue should accept many queues' do
     RJ.publish_to(:rspec_queue, TestJob)
     RJ.publish_to(:rspec_queue2, TestJob)
     RJ.publish_to(:rspec_queue3, TestJob)
-    RJ.purge_queue(:rspec_queue, :rspec_queue2, :rspec_queue3).should == 3
+    RJ.queue_status('rspec_queue')[:message_count].to_i.should == 1
+    RJ.queue_status('rspec_queue2')[:message_count].to_i.should == 1
+    RJ.queue_status('rspec_queue3')[:message_count].to_i.should == 1
+    RJ.purge_queue(:rspec_queue, :rspec_queue2, :rspec_queue3)
+    RJ.queue_status('rspec_queue')[:message_count].to_i.should == 0
+    RJ.queue_status('rspec_queue2')[:message_count].to_i.should == 0
+    RJ.queue_status('rspec_queue3')[:message_count].to_i.should == 0
   end
 
   it 'should publish job with *params' do
     RJ.publish_to(:rspec_queue, JobWithArgsArray, 'first value', :some_symbol, 123, 'and string')
-    RJ.purge_queue(:rspec_queue).should == 1
+    RJ.queue_status('rspec_queue')[:message_count].to_i.should == 1
+    RJ.purge_queue(:rspec_queue)
+    RJ.queue_status('rspec_queue')[:message_count].to_i.should == 0
   end
 
   it 'should publish 1000 messages in one second' do
     count = 1000
-    time = Benchmark.measure {
+    time = Benchmark.measure do
       count.times { RJ.publish_to(:rspec_queue, TestJob) }
-      removed = RJ.purge_queue(:rspec_queue, :rspec_queue2, :rspec_queue3)
-      removed.should == count
-    }
+      to_remove = RJ.queue_status('rspec_queue')[:message_count].to_i
+      to_remove += RJ.queue_status('rspec_queue2')[:message_count].to_i
+      to_remove += RJ.queue_status('rspec_queue3')[:message_count].to_i
+      to_remove.should == count
+
+      RJ.purge_queue(:rspec_queue, :rspec_queue2, :rspec_queue3)
+
+      remains = RJ.queue_status('rspec_queue')[:message_count].to_i
+      remains += RJ.queue_status('rspec_queue2')[:message_count].to_i
+      remains += RJ.queue_status('rspec_queue3')[:message_count].to_i
+      remains.should == 0
+    end
     puts time
   end
-end
+end

data/spec/integration/scheduler_spec.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 require 'spec_helper'
 
 describe RabbitJobs::Scheduler do
@@ -6,10 +5,16 @@ describe RabbitJobs::Scheduler do
     scheduler = RabbitJobs::Scheduler.new
     scheduler.schedule = YAML.load_file(File.expand_path('../../fixtures/schedule.yml', __FILE__))
 
-    scheduler.work(10) # work for 1 second
+    # stop scheduler after 3 seconds
+    Thread.start do
+      sleep 3
+      scheduler.shutdown
+    end
+    scheduler.work
 
     RJ.config.queue 'default', RJ::Configuration::DEFAULT_QUEUE_PARAMS
-    puts "messages queued: " + RJ.purge_queue('default').to_s
-    RJ.purge_queue('default').should == 0
+    puts "messages queued: #{RJ.purge_queue('default')}"
+    RJ.queue_status('default')[:message_count].to_i.should == 0
+    RJ.purge_queue('default')
   end
-end
+end

data/spec/integration/worker_spec.rb

@@ -5,7 +5,7 @@ describe RabbitJobs::Worker do
   it 'should allow to publish jobs from worker' do
     RabbitJobs.configure do |c|
       c.server 'amqp://localhost/rj'
-      c.queue 'rspec_durable_queue', auto_delete: false, durable: true, ack: true
+      c.queue 'rspec_durable_queue', auto_delete: false, durable: true, manual_ack: true
     end
 
     RJ::Publisher.purge_queue('rspec_durable_queue')
@@ -13,6 +13,13 @@ describe RabbitJobs::Worker do
 
     worker = RabbitJobs::Worker.new
     # mock(RJ).publish_to(:rspec_durable_queue, JobWithPublish, 5)
-    worker.work(3) # work for 1 second
+
+    # stop worker after 3 seconds
+    Thread.start do
+      sleep 3
+      worker.shutdown
+    end
+
+    worker.work
   end
-end
+end

data/spec/spec_helper.rb

@@ -1,7 +1,11 @@
-# -*- encoding : utf-8 -*-
 require 'simplecov'
 SimpleCov.start do
-  add_filter "spec" # ignore spec files
+  add_filter 'spec' # ignore spec files
+end
+
+if ENV['CC']
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.start
 end
 
 require 'rr'
@@ -27,4 +31,4 @@ RSpec.configure do |config|
     # config.formatter = :progress
     config.formatter = :html
   end
-end
+end

data/spec/unit/configuration_spec.rb

@@ -1,33 +1,45 @@
-# -*- encoding : utf-8 -*-
 require 'spec_helper'
 
 describe RabbitJobs::Configuration do
+  around(:each) do |example|
+    old_config = RJ.instance_variable_get '@configuration'
+    RJ.instance_variable_set '@configuration', nil
+    example.run
+    RJ.instance_variable_set '@configuration', old_config
+  end
+
   it 'builds configuration from configure block' do
     RabbitJobs.configure do |c|
       c.disable_error_log
 
-      c.server "amqp://somehost.lan"
+      c.server 'amqp://somehost.lan'
 
-      c.queue 'durable_queue', durable: true,  auto_delete: false, ack: true, arguments: {'x-ha-policy' => 'all'}
-      c.queue 'fast_queue',    durable: false, auto_delete: true,  ack: false
+      c.queue 'durable_queue', durable: true,  auto_delete: false, manual_ack: true, arguments: { 'x-ha-policy' => 'all' }
+      c.queue 'fast_queue',    durable: false, auto_delete: true,  manual_ack: false
     end
 
     RabbitJobs.config.to_hash.should == {
       error_log: false,
-      server: "amqp://somehost.lan",
+      server: 'amqp://somehost.lan',
       queues: {
+        jobs: {
+          auto_delete: false,
+          exclusive: false,
+          durable: true,
+          manual_ack: true
+        },
         durable_queue: {
           auto_delete: false,
           exclusive: false,
           durable: true,
-          ack: true,
-          arguments: {"x-ha-policy"=>"all"}
+          manual_ack: true,
+          arguments: { 'x-ha-policy' => 'all' }
         },
         fast_queue: {
           auto_delete: true,
           exclusive: false,
           durable: false,
-          ack: false
+          manual_ack: false
         }
       }
     }
@@ -37,20 +49,20 @@ describe RabbitJobs::Configuration do
     RabbitJobs.config.load_file(File.expand_path('../../fixtures/config.yml', __FILE__))
 
     RabbitJobs.config.to_hash.should == {
-      server: "amqp://example.com/vhost",
+      server: 'amqp://example.com/vhost',
       queues: {
         durable_queue: {
           durable: true,
           exclusive: false,
           auto_delete: false,
-          ack: true,
-          arguments: {"x-ha-policy"=>"all"}
+          manual_ack: true,
+          arguments: { 'x-ha-policy' => 'all' }
         },
         fast_queue: {
           durable: false,
           exclusive: false,
           auto_delete: true,
-          ack: false
+          manual_ack: false
         }
       }
     }
@@ -59,14 +71,21 @@ describe RabbitJobs::Configuration do
   it 'use default value for #server' do
     RabbitJobs.config.to_hash.should == {
       error_log: true,
-      server: "amqp://localhost",
-      queues: {}
+      server: 'amqp://localhost',
+      queues: {
+        jobs: {
+          auto_delete: false,
+          exclusive: false,
+          durable: true,
+          manual_ack: true
+        }
+      }
     }
   end
 
   it 'returns settings on some methods' do
-    RabbitJobs.config.error_log == true
-    RabbitJobs.config.server.should == 'amqp://localhost'
-    RabbitJobs.config.routing_keys.should == []
+    RabbitJobs.config.error_log.should eq true
+    RabbitJobs.config.server.should eq 'amqp://localhost'
+    RabbitJobs.config.routing_keys.should eq [:jobs]
   end
-end
+end