qu-mongoid 0.2.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,2 @@
+services:
+  - mongodb

data/Gemfile

@@ -0,0 +1,14 @@
+source :rubygems
+
+# Specify your gem's dependencies in qu-mongoid.gemspec
+gemspec
+
+group :test do
+  gem 'SystemTimer',  :platform => :mri_18
+  gem 'ruby-debug',   :platform => :mri_18
+  gem 'debugger',     :platform => :mri_19
+  gem 'rake'
+  gem 'rspec', '~> 2.0'
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 dwbutler
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Qu-Mongoid
+[![Build Status](https://secure.travis-ci.org/dwbutler/qu-mongoid.png)](http://travis-ci.org/dwbutler/qu-mongoid)
+
+This gem provides a Mongoid 3 / Moped backend for the queueing library [Qu](http://github.com/bkeepers/qu). See the documentation for Qu for more information.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'qu'
+    gem 'qu-mongoid'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install qu-mongoid
+
+## Why not just use the Mongo backend?
+
+Starting with version 3, Mongoid uses its own mongoDB driver (Moped) instead of the official 10gen ruby driver (mongo). To avoid loading both drivers, I ported the Mongo backend to Mongoid/Moped.
+
+Mongoid version 2 and below uses the mongo driver, so use qu-mongo if you are on Mongoid 2.
+
+## Configuration
+
+Qu-Mongoid will automatically connect to the default session configured in mongoid.yml. If a default session is not configured, it will attempt to read from ENV['MONGOHQ_URL'] and ENV['MONGOLAB_URI'], so it should work on Heroku. If you need to use a different Mongoid connection, you can do the following:
+
+``` ruby
+Qu.configure do |c|
+  c.connection = Mongoid::Sessions.with_name(:qu)
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[--color]
+  t.verbose = false
+end
+
+task :default => :spec

data/lib/qu-mongoid.rb

@@ -0,0 +1,4 @@
+require 'qu'
+require 'qu/backend/mongoid'
+
+Qu.backend = Qu::Backend::Mongoid.new

data/lib/qu-mongoid/version.rb

@@ -0,0 +1,5 @@
+module Qu
+  module Mongoid
+    VERSION = "0.2.0"
+  end
+end

data/lib/qu/backend/mongoid.rb

@@ -0,0 +1,131 @@
+require 'mongoid'
+
+module Qu
+  module Backend
+    class Mongoid < Base
+
+      # Number of times to retry connection on connection failure (default: 5)
+      attr_accessor :max_retries
+
+      # Seconds to wait before try to reconnect after connection failure (default: 1)
+      attr_accessor :retry_frequency
+
+      # Seconds to wait before looking for more jobs when the queue is empty (default: 5)
+      attr_accessor :poll_frequency
+
+      def initialize
+        self.max_retries     = 5
+        self.retry_frequency = 1
+        self.poll_frequency  = 5
+      end
+
+      def connection
+        @connection ||= begin
+          unless ::Mongoid.sessions[:default]
+            if (uri = (ENV['MONGOHQ_URL'] || ENV['MONGOLAB_URI']).to_s) && !uri.empty?
+              ::Mongoid.sessions = {:default => {:uri => uri, :max_retries_on_connection_failure => 4}}
+            else
+              ::Mongoid.connect_to('qu')
+            end
+          end
+          ::Mongoid::Sessions.default
+        end
+      end
+      alias_method :database, :connection
+
+      def clear(queue = nil)
+        queue ||= queues + ['failed']
+        logger.info { "Clearing queues: #{queue.inspect}" }
+        Array(queue).each do |q|
+          logger.debug "Clearing queue #{q}"
+          jobs(q).drop
+          self[:queues].where({:name => q}).remove
+        end
+      end
+
+      def queues
+        self[:queues].find.map {|doc| doc['name'] }
+      end
+
+      def length(queue = 'default')
+        jobs(queue).find.count
+      end
+
+      def enqueue(payload)
+        payload.id = ::Moped::BSON::ObjectId.new
+        jobs(payload.queue).insert({:_id => payload.id, :klass => payload.klass.to_s, :args => payload.args})
+        self[:queues].where({:name => payload.queue}).upsert({:name => payload.queue})
+        logger.debug { "Enqueued job #{payload}" }
+        payload
+      end
+
+      def reserve(worker, options = {:block => true})
+        loop do
+          worker.queues.each do |queue|
+            logger.debug { "Reserving job in queue #{queue}" }
+
+            begin
+              doc = connection.command(:findAndModify => jobs(queue).name, :remove => true)
+              if doc && doc['value']
+                doc = doc['value']
+                doc['id'] = doc.delete('_id')
+                return Payload.new(doc)
+              end
+            rescue ::Moped::Errors::OperationFailure
+              # No jobs in the queue (MongoDB <2)
+            end
+          end
+
+          if options[:block]
+            sleep poll_frequency
+          else
+            break
+          end
+        end
+      end
+
+      def release(payload)
+        jobs(payload.queue).insert({:_id => payload.id, :klass => payload.klass.to_s, :args => payload.args})
+      end
+
+      def failed(payload, error)
+        jobs('failed').insert(:_id => payload.id, :klass => payload.klass.to_s, :args => payload.args, :queue => payload.queue)
+      end
+
+      def completed(payload)
+      end
+
+      def register_worker(worker)
+        logger.debug "Registering worker #{worker.id}"
+        self[:workers].insert(worker.attributes.merge(:id => worker.id))
+      end
+
+      def unregister_worker(worker)
+        logger.debug "Unregistering worker #{worker.id}"
+        self[:workers].where(:id => worker.id).remove
+      end
+
+      def workers
+        self[:workers].find.map do |doc|
+          Qu::Worker.new(doc)
+        end
+      end
+
+      def clear_workers
+        logger.info "Clearing workers"
+        self[:workers].drop
+      end
+
+    private
+
+      def jobs(queue)
+        self["queue:#{queue}"]
+      end
+
+      def [](name)
+        database["qu:#{name}"]
+      end
+
+    end
+  end
+end

data/qu-mongoid.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "qu-mongoid/version"
+
+Gem::Specification.new do |s|
+  s.name        = "qu-mongoid"
+  s.version     = Qu::Mongoid::VERSION
+  s.authors     = ["David Butler"]
+  s.email       = ["dwbutler@ucla.edu"]
+  s.homepage    = "http://github.com/dwbutler/qu-mongoid"
+  s.summary     = "Mongoid backend for Qu"
+  s.description = "Mongoid backend for the Ruby queuing library Qu"
+
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'mongoid', '~> 3.0'
+  s.add_dependency 'qu'
+end

data/spec/qu/backend/mongoid_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+require 'qu-mongoid'
+
+describe Qu::Backend::Mongoid do
+  it_should_behave_like 'a backend'
+
+  describe 'connection' do
+    it 'should default the qu database' do
+      subject.connection.should be_instance_of(Moped::Session)
+      subject.connection.options[:database].should == 'qu'
+    end
+    
+    it 'should use MONGOHQ_URL from heroku' do
+      # Clean up from other tests
+      ::Mongoid.sessions[:default]  = nil
+      subject.instance_eval {@connection=nil}
+      ::Mongoid::Sessions.clear
+      
+      ENV['MONGOHQ_URL'] = 'mongodb://127.0.0.1:27017/quspec'
+      subject.connection.options[:database].should == 'quspec'
+      subject.connection.cluster.nodes.first.resolved_address.should == "127.0.0.1:27017"
+      ::Mongoid.sessions[:default][:hosts].should include("127.0.0.1:27017")
+      
+      # Clean up MONGOHQ stuff
+      ENV.delete('MONGOHQ_URL')
+      subject.instance_eval {@connection=nil}
+      ::Mongoid.connect_to('qu')
+    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
+        Moped::Session.any_instance.should_receive(:command).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
+        subject.connection.should_receive(:command).and_raise(Moped::Errors::OperationFailure.new(nil, 'test'))
+        lambda { subject.reserve(worker, :block => false).should be_nil }.should_not raise_error
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler.require :test
+require 'qu'
+require 'qu/backend/spec'
+
+RSpec.configure do |config|
+  config.before do
+    Qu.backend = mock('a backend', :reserve => nil, :failed => nil, :completed => nil,
+      :register_worker => nil, :unregister_worker => nil)
+    Qu.failure = nil
+  end
+end
+
+Qu.logger = Logger.new('/dev/null')

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: qu-mongoid
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- David Butler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: qu
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Mongoid backend for the Ruby queuing library Qu
+email:
+- dwbutler@ucla.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/qu-mongoid.rb
+- lib/qu-mongoid/version.rb
+- lib/qu/backend/mongoid.rb
+- qu-mongoid.gemspec
+- spec/qu/backend/mongoid_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/dwbutler/qu-mongoid
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Mongoid backend for Qu
+test_files: []
+has_rdoc: