qu 0.1.4 → 0.2.0

data/ChangeLog

@@ -1,3 +1,24 @@
+0.2.0 - 2012-06-13
+
+  Backwards-incompatible Changes:
+
+    * Remove #requeue from all backends. It was not used internally.
+    * Move implicit Rails dependency to it's own Gem, which you must declare now in your Gemfile.
+
+        gem 'qu-rails'
+
+  Enhancements
+
+    * qu-mongo: Add mongolab environment variable for automatic configuration on Heroku.
+
+  Bug Fixes:
+
+    * Fixing Immediate backend to satisfy the backend interface
+
+
+  https://github.com/bkeepers/qu/compare/v0.1.4...v0.2.0
+
+
 0.1.4 - 2012-01-07
 
   Enhancements:
@@ -10,6 +31,7 @@
 
   https://github.com/bkeepers/qu/compare/v0.1.3...v0.1.4
 
+
 0.1.3 - 2011-10-10
 
   Bug Fixes:
@@ -28,6 +50,7 @@
 
   https://github.com/bkeepers/qu/compare/v0.1.2..v0.1.3
 
+
 0.1.2 - 2011-10-05
 
   Bug Fixes:
@@ -36,6 +59,7 @@
 
   https://github.com/bkeepers/qu/compare/v0.1.1...v0.1.2
 
+
 0.1.1 - 2011-10-02
 
   Bug Fixes:

data/Gemfile

@@ -3,18 +3,15 @@ gemspec :name => 'qu'
 
 Dir['qu-*.gemspec'].each do |gemspec|
   plugin = gemspec.scan(/qu-(.*)\.gemspec/).flatten.first
-
-  group plugin do
-    gemspec(:name => "qu-#{plugin}", :development_group => plugin)
-  end
+  gemspec(:name => "qu-#{plugin}", :development_group => plugin)
 end
 
 group :test do
   gem 'SystemTimer',  :platform => :mri_18
   gem 'ruby-debug',   :platform => :mri_18
-  gem 'ruby-debug19', :platform => :mri_19, :require => 'ruby-debug'
+  gem 'debugger',     :platform => :mri_19
   gem 'rake'
   gem 'rspec', '~> 2.0'
   gem 'guard-rspec'
   gem 'guard-bundler'
-end
+end

data/README.md

@@ -21,6 +21,7 @@ Qu was created to overcome some shortcomings in the existing queuing libraries t
 Decide which backend you want to use and add the gem to your `Gemfile`.
 
 ``` ruby
+gem 'qu-rails'
 gem 'qu-redis'
 ```
 

data/lib/qu.rb

@@ -35,11 +35,3 @@ Qu.configure do |c|
   c.logger.level = Logger::INFO
 end
 
-if defined?(Rails)
-  if defined?(Rails::Railtie)
-    require 'qu/railtie'
-  else
-    Qu.logger = Rails.logger
-  end
-end
-

data/lib/qu/backend/immediate.rb

@@ -13,6 +13,29 @@ module Qu
 
       def failed(payload, error)
       end
+
+      def register_worker(*)
+      end
+
+      def unregister_worker(*)
+      end
+
+      def clear(*)
+      end
+
+      def connection=(*)
+      end
+
+      def reserve(*)
+      end
+
+      def length(*)
+        0
+      end
+
+      def queues(*)
+        ["default"]
+      end
     end
   end
 end

data/lib/qu/backend/spec.rb

@@ -200,44 +200,6 @@ shared_examples_for 'a backend' do
     end
   end
 
-  describe 'requeue' do
-    context 'with a failed job' do
-      before do
-        subject.enqueue(payload)
-        subject.reserve(worker).id.should == payload.id
-        subject.failed(payload, Exception.new)
-      end
-
-      it 'should add the job back on the queue' do
-        subject.length(payload.queue).should == 0
-        subject.requeue(payload.id)
-        subject.length(payload.queue).should == 1
-
-        p = subject.reserve(worker)
-        p.should be_instance_of(Qu::Payload)
-        p.id.should == payload.id
-        p.klass.should == payload.klass
-        p.args.should == payload.args
-      end
-
-      it 'should remove the job from the failed jobs' do
-        subject.length('failed').should == 1
-        subject.requeue(payload.id)
-        subject.length('failed').should == 0
-      end
-
-      it 'should return the job' do
-        subject.requeue(payload.id).id.should == payload.id
-      end
-    end
-
-    context 'without a failed job' do
-      it 'should return false' do
-        subject.requeue('1').should be_false
-      end
-    end
-  end
-
   describe 'register_worker' do
     it 'should add worker to array of workers' do
       subject.register_worker(worker)

data/lib/qu/version.rb

@@ -1,3 +1,3 @@
 module Qu
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
 end

data/qu-airbrake.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "qu/version"
+
+Gem::Specification.new do |s|
+  s.name        = "qu-airbrake"
+  s.version     = Qu::VERSION
+  s.authors     = ["Brandon Keepers", "Scott Ellard"]
+  s.email       = ["brandon@opensoul.org"]
+  s.homepage    = "http://github.com/bkeepers/qu"
+  s.summary     = "Airbrake failure backend for qu"
+  s.description = "Airbrake failure backend for qu"
+
+  s.files         = `git ls-files -- lib | grep airbrake`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'airbrake'
+  s.add_dependency 'i18n'
+  s.add_dependency 'qu', Qu::VERSION
+end

data/qu-exceptional.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "qu/version"
+
+Gem::Specification.new do |s|
+  s.name        = "qu-exceptional"
+  s.version     = Qu::VERSION
+  s.authors     = ["Brandon Keepers"]
+  s.email       = ["brandon@opensoul.org"]
+  s.homepage    = "http://github.com/bkeepers/qu"
+  s.summary     = "Exceptional failure backend for qu"
+  s.description = "Exceptional failure backend for qu"
+
+  s.files         = `git ls-files -- lib | grep exceptional`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'exceptional'
+  s.add_dependency 'qu', Qu::VERSION
+end

data/qu-mongo.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "qu/version"
+
+Gem::Specification.new do |s|
+  s.name        = "qu-mongo"
+  s.version     = Qu::VERSION
+  s.authors     = ["Brandon Keepers"]
+  s.email       = ["brandon@opensoul.org"]
+  s.homepage    = "http://github.com/bkeepers/qu"
+  s.summary     = "Mongo backend for qu"
+  s.description = "Mongo backend for qu"
+
+  s.files         = `git ls-files -- lib | grep mongo`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'mongo'
+  s.add_dependency 'qu', Qu::VERSION
+
+  s.add_development_dependency 'bson_ext'
+end

data/qu-rails.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "qu/version"
+
+Gem::Specification.new do |s|
+  s.name        = "qu-rails"
+  s.version     = Qu::VERSION
+  s.authors     = ["Brandon Keepers"]
+  s.email       = ["brandon@opensoul.org"]
+  s.homepage    = "http://github.com/bkeepers/qu"
+  s.summary     = "Rails integration for qu"
+  s.description = "Rails integration for qu"
+
+  s.files         = `git ls-files -- lib | grep rails`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'rails', '~>3.0'
+  s.add_dependency 'qu', Qu::VERSION
+end

data/qu-redis.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "qu/version"
+
+Gem::Specification.new do |s|
+  s.name        = "qu-redis"
+  s.version     = Qu::VERSION
+  s.authors     = ["Brandon Keepers"]
+  s.email       = ["brandon@opensoul.org"]
+  s.homepage    = "http://github.com/bkeepers/qu"
+  s.summary     = "Redis backend for qu"
+  s.description = "Redis backend for qu"
+
+  s.files         = `git ls-files -- lib | grep redis`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'redis-namespace'
+  s.add_dependency 'simple_uuid'
+  s.add_dependency 'qu', Qu::VERSION
+end

data/qu.gemspec

@@ -2,7 +2,9 @@
 $:.push File.expand_path("../lib", __FILE__)
 require "qu/version"
 
-plugins = Dir['qu-*.gemspec'].map {|gemspec| gemspec.scan(/qu-(.*)\.gemspec/).flatten.first }.join('\|')
+plugin_files = Dir['qu-*.gemspec'].map { |gemspec|
+  eval(File.read(gemspec)).files
+}.flatten.uniq
 
 Gem::Specification.new do |s|
   s.name        = "qu"
@@ -10,11 +12,11 @@ Gem::Specification.new do |s|
   s.authors     = ["Brandon Keepers"]
   s.email       = ["brandon@opensoul.org"]
   s.homepage    = "http://github.com/bkeepers/qu"
-  s.summary     = %q{}
-  s.description = %q{}
+  s.summary     = %q{a Ruby library for queuing and processing background jobs.}
+  s.description = %q{a Ruby library for queuing and processing background jobs with configurable backends.}
 
-  s.files         = `git ls-files | grep -v '#{plugins}'`.split("\n")
-  s.test_files    = `git ls-files -- spec | grep -v '#{plugins}'`.split("\n")
+  s.files         = `git ls-files`.split("\n") - plugin_files
+  s.test_files    = `git ls-files -- spec`.split("\n")
   s.executables   = `git ls-files -- bin`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 

data/spec/qu/backend/mongo_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+require 'qu-mongo'
+
+describe Qu::Backend::Mongo do
+  it_should_behave_like 'a backend'
+
+  before do
+    ENV.delete('MONGOHQ_URL')
+  end
+
+  describe 'connection' do
+    it 'should default the qu database' do
+      subject.connection.should be_instance_of(Mongo::DB)
+      subject.connection.name.should == 'qu'
+    end
+
+    it 'should use MONGOHQ_URL from heroku' do
+      Mongo::Connection.any_instance.stub(:connect)
+      ENV['MONGOHQ_URL'] = 'mongodb://user:pw@host:10060/quspec'
+      subject.connection.name.should == 'quspec'
+      # debugger
+      subject.connection.connection.host_to_try.should == ['host', 10060]
+      subject.connection.connection.auths.should == [{'db_name' => 'quspec', 'username' => 'user', 'password' => 'pw'}]
+    end
+
+    context "Connection Failure" do
+      let(:retries_number) { 3 }
+      let(:retries_frequency) { 5 }
+
+      before do
+        subject.max_retries = retries_number
+        subject.retry_frequency = retries_frequency
+
+        Mongo::DB.any_instance.stub(:[]).and_raise(Mongo::ConnectionFailure)
+        subject.stub(:sleep)
+      end
+
+      it "raise error" do
+        expect { subject.queues }.to raise_error(Mongo::ConnectionFailure)
+      end
+
+      it "trying to reconect" do
+        subject.database.should_receive(:[]).exactly(4).times.and_raise(Mongo::ConnectionFailure)
+        expect { subject.queues }.to raise_error
+      end
+
+      it "sleep between tries" do
+        subject.should_receive(:sleep).with(5).ordered
+        subject.should_receive(:sleep).with(10).ordered
+        subject.should_receive(:sleep).with(15).ordered
+
+        expect { subject.queues }.to raise_error
+      end
+
+    end
+  end
+
+  describe 'reserve' do
+    let(:worker) { Qu::Worker.new }
+
+    describe "on mongo >=2" do
+      it 'should return nil when no jobs exist' do
+        subject.clear
+        Mongo::Collection.any_instance.should_receive(:find_and_modify).and_return(nil)
+        lambda { subject.reserve(worker, :block => false).should be_nil }.should_not raise_error
+      end
+    end
+
+    describe 'on mongo <2' do
+      it 'should return nil when no jobs exist' do
+        subject.clear
+        Mongo::Collection.any_instance.should_receive(:find_and_modify).and_raise(Mongo::OperationFailure)
+        lambda { subject.reserve(worker, :block => false).should be_nil }.should_not raise_error
+      end
+    end
+  end
+end

data/spec/qu/backend/redis_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+require 'qu-redis'
+
+describe Qu::Backend::Redis do
+  it_should_behave_like 'a backend'
+
+  let(:worker) { Qu::Worker.new('default') }
+
+  before do
+    ENV.delete('REDISTOGO_URL')
+  end
+
+  describe 'completed' do
+    it 'should delete job' do
+      subject.enqueue(Qu::Payload.new(:klass => SimpleJob))
+      job = subject.reserve(worker)
+      subject.redis.exists("job:#{job.id}").should be_true
+      subject.completed(job)
+      subject.redis.exists("job:#{job.id}").should be_false
+    end
+  end
+
+  describe 'clear_workers' do
+    before { subject.register_worker worker }
+
+    it 'should delete worker key' do
+      subject.redis.get("worker:#{worker.id}").should_not be_nil
+      subject.clear_workers
+      subject.redis.get("worker:#{worker.id}").should be_nil
+    end
+  end
+
+  describe 'connection' do
+    it 'should create default connection if one not provided' do
+      subject.connection.client.host.should == '127.0.0.1'
+      subject.connection.client.port.should == 6379
+      subject.connection.namespace.should == :qu
+    end
+
+    it 'should use REDISTOGO_URL from heroku with namespace' do
+      ENV['REDISTOGO_URL'] = 'redis://0.0.0.0:9876'
+      subject.connection.client.host.should == '0.0.0.0'
+      subject.connection.client.port.should == 9876
+      subject.connection.namespace.should == :qu
+    end
+
+    it 'should allow customizing the namespace' do
+      subject.namespace = :foobar
+      subject.connection.namespace.should == :foobar
+    end
+  end
+
+  describe 'clear' do
+    it 'should delete jobs' do
+      job = subject.enqueue(Qu::Payload.new(:klass => SimpleJob))
+      subject.redis.exists("job:#{job.id}").should be_true
+      subject.clear
+      subject.redis.exists("job:#{job.id}").should be_false
+    end
+  end
+end

data/spec/qu/failure/airbrake_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+require 'qu-airbrake'
+
+describe Qu::Failure::Airbrake do
+
+  let(:job) { Qu::Payload.new(:id => '123', :klass => SimpleJob, :args => ['987']) }
+
+  describe ".extra_stuff" do
+    it 'should return job data' do
+      described_class.extra_stuff(job).should == {
+        :parameters => {
+          :id     => '123',
+          :queue  => 'default',
+          :args   => ['987'],
+          :class  => 'SimpleJob'
+        }
+      }
+    end
+  end
+
+  describe '.create' do
+    let(:exception) { Exception.new }
+    
+    it 'should send error' do
+      ::Airbrake.should_receive(:notify_or_ignore).with(exception, described_class.extra_stuff(job))
+      described_class.create(job, exception)
+    end
+  end
+end

data/spec/qu/failure/exceptional_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+require 'qu-exceptional'
+
+describe Qu::Failure::Exceptional do
+  let(:job) { Qu::Payload.new(:id => '123', :klass => SimpleJob, :args => ['987']) }
+
+  describe Qu::Failure::Exceptional::ExceptionData do
+    subject { Qu::Failure::Exceptional::ExceptionData.new(job, Exception.new) }
+
+    it 'should include job data in the request' do
+      subject.extra_stuff.should == {
+        'request' => {
+          'parameters' => {
+            'id'    => '123',
+            'queue' => 'default',
+            'args'  => ['987'],
+            'class' => 'SimpleJob'
+          }
+        },
+        'rescue_block' => {
+          'name'    => 'SimpleJob'
+        }
+      }
+    end
+  end
+
+  describe 'create' do
+    context 'with exceptional enabled' do
+      before do
+        Exceptional::Config.enabled = true
+      end
+
+      it 'should send error' do
+        Exceptional::Remote.should_receive(:error).with(instance_of(Qu::Failure::Exceptional::ExceptionData))
+        described_class.create(job, Exception.new)
+      end
+    end
+
+    context 'with exceptional disabled' do
+      before do
+        Exceptional::Config.enabled = false
+      end
+
+      it 'should not send error' do
+        Exceptional::Remote.should_not_receive(:error)
+        described_class.create(job, Exception.new)
+      end
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: qu
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 4
-  version: 0.1.4
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Brandon Keepers
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-07 00:00:00 -05:00
-default_executable: 
+date: 2012-06-13 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: multi_json
@@ -32,7 +31,7 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id001
-description: ""
+description: a Ruby library for queuing and processing background jobs with configurable backends.
 email: 
 - brandon@opensoul.org
 executables: []
@@ -56,17 +55,24 @@ files:
 - lib/qu/failure.rb
 - lib/qu/logger.rb
 - lib/qu/payload.rb
-- lib/qu/railtie.rb
 - lib/qu/tasks.rb
 - lib/qu/version.rb
 - lib/qu/worker.rb
+- qu-airbrake.gemspec
+- qu-exceptional.gemspec
+- qu-mongo.gemspec
+- qu-rails.gemspec
+- qu-redis.gemspec
 - qu.gemspec
 - spec/qu/backend/immediate_spec.rb
+- spec/qu/backend/mongo_spec.rb
+- spec/qu/backend/redis_spec.rb
+- spec/qu/failure/airbrake_spec.rb
+- spec/qu/failure/exceptional_spec.rb
 - spec/qu/payload_spec.rb
 - spec/qu/worker_spec.rb
 - spec/qu_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/bkeepers/qu
 licenses: []
 
@@ -96,12 +102,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.1
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
-summary: ""
+summary: a Ruby library for queuing and processing background jobs.
 test_files: 
 - spec/qu/backend/immediate_spec.rb
+- spec/qu/backend/mongo_spec.rb
+- spec/qu/backend/redis_spec.rb
+- spec/qu/failure/airbrake_spec.rb
+- spec/qu/failure/exceptional_spec.rb
 - spec/qu/payload_spec.rb
 - spec/qu/worker_spec.rb
 - spec/qu_spec.rb

data/lib/qu/railtie.rb

@@ -1,13 +0,0 @@
-require 'qu'
-
-module Qu
-  class Railtie < Rails::Railtie
-    rake_tasks do
-      load "qu/tasks.rb"
-    end
-
-    initializer "qu.logger" do |app|
-      Qu.logger = Rails.logger
-    end
-  end
-end