mongodb_queue 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a379e4ec7e6b43e4166d273dc9eff160010afd3e
+  data.tar.gz: e6b9fc4e04a191106eb1c5dd6dad91d198a7da3a
+SHA512:
+  metadata.gz: b5fb39651738ec15e074ab64e2412f2817fd4883fa30fcdc8d321c1b12c7e45e8c9ba449a2a58a64c3cea106769b22caa6476d688236e406f4be38966da38bfb
+  data.tar.gz: edf9e76abd37c8d3bce8a31f9d5fbaf95ce4969be9d1e1811fdc6ae57742fec385df72cd44325f737b73ec8ca057d2c13256b014323e6864fbd875caa69f6ee1

data/.gitignore

@@ -0,0 +1,42 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+Gemfile.lock
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Specific to IntelliJ
+/.idea/
+*.iml
+
+test/mongo_config_helper.rb
+test/reports

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongodb_queue.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,124 @@
+mongodb_queue
+=============
+
+[![Build Status](https://api.shippable.com/projects/5498868ed46935d5fbc0d547/badge?branchName=master)](https://app.shippable.com/projects/5498868ed46935d5fbc0d547/builds/latest) [![Gem Version](https://badge.fury.io/rb/mongodb_queue.svg)](http://badge.fury.io/rb/mongodb_queue) [![Downloads](http://ruby-gem-downloads-badge.herokuapp.com/mongodb_queue?type=total)](https://rubygems.org/gems/mongodb_queue)
+
+
+MongoDB based work queue written in Ruby.  Supports multiple queues.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mongodb_queue'
+```
+
+And then execute:
+
+$ bundle
+
+Or install it yourself as:
+
+$ gem install mongodb_queue
+
+## Usage
+
+```ruby
+require 'mongodb_queue'
+
+queue = MongoDBQueue::MongoDBQueue.new({address: 'localhost', port: 27017, database: 'test-db', collection: 'test-queue'})
+person = {name: 'John', age: 32, id: '123456789'}
+person2 = {name: 'Jane', age: 29, id: '123456789'}
+
+# Basic Usage
+queue.enqueue(person)
+queued_person = queue.dequeue
+
+# Custom Queue Names
+queue.enqueue(person, :friends)
+friend = queue.dequeue(:friends)
+
+# Multiple Queues
+queue.enqueue(person, [:faculty, :staff])
+faculty_member = queue.dequeue(:faculty)
+staff_member = queue.dequeue(:staff)
+
+# Prevent Duplicate Items
+@queue.enqueue(person, :faculty, {unique_field: :id_num})
+@queue.enqueue(person2, :faculty, {unique_field: :id_num})  # This wont be queued
+faculty_member = queue.dequeue(:faculty)
+
+# Delete item when dequeued
+#   Be careful with this if using multiple queues as it deletes the document from all queues.
+queue.enqueue(person, :faculty)
+faculty_member = queue.dequeue(:faculty, {delete: true})
+
+# Use a different dequeued status
+queue.enqueue(person)
+faculty_member = queue.dequeue(MongoDBQueue::DEFAULT_QUEUE, {status: :processing})
+
+# Remove documents that have finished processing
+queue.remove_all([:success, :error])
+
+# Requeue documents that have been in a dequeued status for 5 minutes (300 seconds)
+queue.requeue_timed_out(300)
+
+# Requeue documents that have been in a processing status for 5 minutes (300 seconds)
+queue.requeue_timed_out(300, :processing)
+
+# Unset the name field for successfully processed documents
+queue.unset_all([:success], :name)
+
+# Disconnect from MongoDB when done
+queue.destroy
+```
+
+## Sample MongoDB Document
+
+This is a document that has been added to 2 queues - test_queue and test_queue2.  It has already been dequeued from test_queue
+
+``` json
+{
+    "_id" : ObjectId("549b1678b83b50d6bf000001"),
+    "name" : "John",
+    "age" : 32,
+    "id_num" : "123456789",
+    "queue" : [
+        {
+            "name" : "test_queue",
+            "status" : "dequeued",
+            "queued_timestamp" : ISODate("2014-12-24T19:39:36.051Z"),
+            "dequeued_timestamp" : ISODate("2014-12-24T19:39:36.053Z")
+        },
+        {
+            "name" : "test_queue2",
+            "status" : "queued",
+            "queued_timestamp" : ISODate("2014-12-24T19:39:55.052Z")
+        }
+    ]
+}
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/dashingrocket/mongodb_queue/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+Copyright 2014 Dashing Rocket, Ltd.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'ci/reporter/rake/test_unit'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*_test.rb']
+end
+
+desc 'Run tests'
+task :default => ['ci:setup:testunit', :test]

data/lib/mongodb_queue.rb

@@ -0,0 +1,243 @@
+require 'logger'
+require 'mongo'
+
+module MongoDBQueue
+  # The default queue name
+  DEFAULT_QUEUE = :default_queue
+
+  # The default status of a document that is queued.
+  DEFAULT_QUEUE_STATUS = 'queued'
+  
+  # The default status of a document that is dequeued.
+  DEFAULT_DEQUEUE_STATUS = 'dequeued'
+
+  # MongoDB Backed Queue
+  #
+  # @author Jesse Bowes
+  class MongoDBQueue
+    # The underlying queue's collection
+    attr_reader :collection
+    
+    # Initializer
+    # @param settings [Hash] MongoDB connection settings
+    # @option settings [String]   :address MongoDB address
+    # @option settings [Integer]  :port MongoDB port
+    # @option settings [String]   :database MongoDB database to use
+    # @option settings [String]   :collection MongoDB collection to use
+    # @option settings [String]   :username MongoDB username to use (optional)
+    # @option settings [String]   :password MongoDB password to use (optional)
+    # @param logger [Logger]  Use a specific logger, otherwise logs to STDOUT
+    def initialize(settings, logger=nil)
+      @logger = logger || Logger.new(STDOUT)
+      check_settings(settings)
+      @settings = settings
+      @unique_fields = []
+      connect_mongo
+    end
+    
+    # Disconnects from MongoDB.  Call before exiting.
+    def destroy
+      begin
+        disconnect_mongo
+      rescue; end
+    end
+
+    # Add an object to a queue
+    # @param object [Hash] The object to queue
+    # @param queue_names [Array] A list of queues to add the object to.
+    # @param opts [Hash] Options
+    # @option opts [String] :unique_field Prevent duplicate documents being queued on the same queue by this unique field
+    def enqueue(object, queue_names = [DEFAULT_QUEUE], opts={})
+      connect_mongo
+      unique_field = opts[:unique_field]
+      set_unique unique_field
+      send_queues(queue_names, object, unique_field)
+    end
+
+    # Gets an object from a queue
+    # @param queue_name [String] The queue to get the object from
+    # @param opts [Hash] Options
+    # @option opts [String]  :status ({DEFAULT_DEQUEUE_STATUS}) The status to mark the document as after it's dequeued.
+    # @option opts [Boolean] :delete (false) Delete the object from ALL queues when dequeued.
+    # @return [Hash] Queued object or nil
+    def dequeue(queue_name = DEFAULT_QUEUE, opts={})
+      connect_mongo
+      queue_name = queue_name.to_s
+      status = opts[:status] || DEFAULT_DEQUEUE_STATUS
+      status = status.to_s
+      delete = opts[:delete]
+
+      query = {queue: {'$elemMatch' => {name: queue_name, status: DEFAULT_QUEUE_STATUS}}}
+      
+      if delete
+        @collection.find_and_modify(query: query, remove: true)
+      else
+        @collection.find_and_modify(query: query, update: {'$set' => {'queue.$.status' => status, "queue.$.#{status}_timestamp" => Time.now}})
+      end
+    end
+    
+    # Removes all MongoDB documents that have all their queue statuses set to the provided status(es).
+    # @param statuses [Array] Queue statuses that qualify a document for removal
+    # @return [Integer] Number of documents removed
+    def remove_all(statuses = [DEFAULT_DEQUEUE_STATUS])
+      statuses = [statuses].flatten.map{|s|s.to_s}
+      STDERR.puts "#{statuses}"
+      num_removed = 0
+      potential_items = @collection.find({'queue.status' => {'$in' => statuses}}, {fields: ['queue.status']})
+      potential_items.each do |item|
+        id = item['_id']
+        item_statuses = item['queue'].map{|s|s['status'].to_s}
+        item_statuses.uniq!
+        other_statuses = item_statuses - statuses
+        
+        if other_statuses.empty?
+          result = @collection.remove({'_id' => id})
+          num_removed += result['n'] if result['n']
+        end
+      end
+      num_removed
+    end
+    
+    # Requeues all documents that were dequeued more than timeout_sec ago and have a status that is in statuses
+    # @param statuses [Array] Queue statuses that qualify a document for requeuing
+    # @return [Integer] Number of documents requeued
+    def requeue_timed_out(timeout_sec, statuses = [DEFAULT_DEQUEUE_STATUS])
+      statuses = [statuses].flatten.map{|s|s.to_s}
+      timeout_time = Time.now - timeout_sec
+      num_requeued = 0
+      potential_items = @collection.find({'queue.status' => {'$in' => statuses}}, {fields: ['queue']})
+
+      potential_items.each do |item|
+        id = item['_id']
+        item['queue'].each do |queue|
+          queue_name = queue['name']
+          status = queue['status']
+          timestamp_field = "#{status}_timestamp"
+          timestamp = queue[timestamp_field]
+          
+          if statuses.include?(status) && timestamp < timeout_time
+            # Requeue this item
+            result = @collection.update({'_id' => id, 'queue.name' => queue_name}, {'$set' => {'queue.$.status' => DEFAULT_QUEUE_STATUS}})
+            num_requeued += result['n'] if result['n']
+          end
+        end
+      end
+      num_requeued
+    end
+
+    # Unsets specified fields in MongoDB documents that have all their queue statuses set to the provided status(es).
+    # @param statuses [Array] Queue statuses that qualify a document for unsetting
+    # @param fields [Array] Fields to be unset
+    # @return [Integer] Number of documents removed
+    def unset_all(statuses, fields)
+      statuses = [statuses].flatten.map{|s|s.to_s}
+      fields = [fields].flatten.map{|f|f.to_s}
+      num_modified = 0
+      potential_items = @collection.find({'queue.status' => {'$in' => statuses}}, {fields: ['queue.status']})
+      fields_hash = {}
+      fields.each do |field|
+        fields_hash[field] = ''
+      end
+      potential_items.each do |item|
+        id = item['_id']
+        item_statuses = item['queue'].map{|s|s['status'].to_s}
+        item_statuses.uniq!
+        other_statuses = item_statuses - statuses
+
+        if other_statuses.empty?
+          result = @collection.update({'_id' => id}, {'$unset' => fields_hash})
+          num_modified += result['n'] if result['n']
+        end
+      end
+      num_modified
+    end
+
+    # Sets a specific field as being unique
+    # @param unique_field [String] The field that is unique
+    # @return [String] the name of the index created (if not already created)
+    def set_unique(unique_field)
+      if unique_field && !@unique_fields.include?(unique_field)
+        @unique_fields << unique_field
+        create_index(unique_field, {unique: true})
+      end
+    end
+
+    # Passthrough to create a Mongo Index
+    # @see Mongo::Collection#create_index
+    # @param spec [String] The field that is unique
+    # @return [String] the name of the index created.
+    def create_index(spec, opts={})
+      @collection.create_index(spec, opts)
+    end
+
+    private
+    def check_settings(settings)
+      raise 'No database address set' if settings[:address].nil?
+      raise 'No database port set' if settings[:port].nil?
+      raise 'No database set' if settings[:database].nil?
+      raise 'No collection set' if settings[:collection].nil?
+    end
+
+    def connect_mongo
+      if @client.nil? || !@client.connected?
+        @client = Mongo::MongoClient.new(@settings[:address], @settings[:port])
+        db = @client[@settings[:database]]
+        db.authenticate(@settings[:username], @settings[:password]) if @settings[:username] || @settings[:password]
+        @collection = db[@settings[:collection]]
+        @collection.create_index('queue.name')
+        @collection.create_index('queue.status')
+        @collection.create_index({'queue.name' => Mongo::ASCENDING, 'queue.status' => Mongo::ASCENDING})
+      end
+    end
+
+    def disconnect_mongo
+      @client.close if @client
+    end
+
+    def send_queues(queues, data, unique_field)
+      queues = [queues].flatten
+      queues.reject!{|q| q.nil? || q.empty?}
+      queues.map!{|q|q.to_s}
+      
+      queue_list = []
+      
+      doc = get_existing_doc(data, unique_field)
+
+      if doc.nil?
+        queues.each {|q| queue_list << {name: q, status: DEFAULT_QUEUE_STATUS, "#{DEFAULT_QUEUE_STATUS}_timestamp" => Time.now}}
+        if queue_list.empty?
+          @logger.info "Skipping item #{data.object_id}.  No destination queues."
+          return nil
+        else
+          data[:queue] = queue_list
+          @logger.info "Queuing item #{data.object_id} into #{queue_list.collect{|q|q[:name]}}"
+          return @collection.insert data
+        end
+      else
+        @logger.info "\tAlready received unique #{data[unique_field]}."
+        docid = doc['_id']
+        previous_queues = doc['queue']
+        queues.each do |q|
+          exists = previous_queues.any? {|h| h['name'] == q}
+          queue_list << {name: q, status: DEFAULT_QUEUE_STATUS, "#{DEFAULT_QUEUE_STATUS}_timestamp" => Time.now} unless exists
+        end
+
+        if queue_list.empty?
+          @logger.info "\t\tSkipping item #{data[unique_field]}.  No new queues"
+          return nil
+        else
+          @logger.info "Queuing item #{data[unique_field]} into #{queue_list.collect{|q|q[:name]}}"
+          return @collection.update({'_id' => docid}, {'$set' => data, '$addToSet' => { queue: { '$each' =>queue_list }}})
+        end
+      end
+    end
+    
+    def get_existing_doc(data, unique_field)
+      if unique_field
+        @collection.find({unique_field => data[unique_field]}).next_document
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/mongodb_queue/version.rb

@@ -0,0 +1,5 @@
+# Namespace for classes and modules that handle MongoDB Backed Queue
+module MongoDBQueue
+  # MongoDBQueue Version
+  VERSION = '1.0.0'
+end

data/mongodb_queue.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongodb_queue/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mongodb_queue'
+  spec.version       = MongoDBQueue::VERSION
+  spec.authors       = ['Jesse Bowes']
+  spec.email         = ['jbowes@dashingrocket.com']
+  spec.summary       = 'MongoDB Messaging Queue'
+  spec.description   = 'A mongoDB based messaging queue that supports multiple queues'
+  spec.homepage      = 'https://github.com/dashingrocket/mongodb_queue'
+  spec.license       = 'Apache-2.0'
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'ci_reporter_test_unit'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-cobertura'
+
+  spec.add_runtime_dependency 'bson_ext', '~> 1.11'
+  spec.add_runtime_dependency 'mongo', '~> 1.11'
+end

data/shippable.yml

@@ -0,0 +1,25 @@
+language: ruby
+
+rvm:
+  - 1.9
+  - 2.0.0
+  - 2.1
+
+services:
+  - mongodb
+  
+before_script:
+  - mongo test-db --eval 'db.addUser("test-user", "test-pass");'
+  - mongod --version
+  
+env:
+  - CI_REPORTS=shippable/testresults COVERAGE_REPORTS=shippable/codecoverage
+
+cache: true
+  
+notifications:
+  email:
+    recipients:
+      - jbowes@dashingrocket.com
+    on_success: change
+    on_failure: always

data/test/mongodb_queue_test.rb

@@ -0,0 +1,260 @@
+require_relative 'test_helper'
+
+require 'test/unit'
+require 'mongodb_queue'
+
+class MongoDBQueueTest < Test::Unit::TestCase
+
+  # Called before every test method runs. Can be used
+  # to set up fixture information.
+  def setup
+    @config = get_config
+    @queue = MongoDBQueue::MongoDBQueue.new(@config)
+    
+    @inspect_queue = @queue.collection
+  end
+
+  # the uby mongo driver appears to derive _id from ruby's object id, so lets make a new object
+  def get_person
+    {name: 'John', age: 32, id_num: '123456789'}
+  end
+
+  # Get config or overridden config
+  def get_config
+    begin
+      # Allow overriding of config for local testing
+      require_relative 'mongo_config_helper'
+      config = MongoDBConfigHelper::config
+    rescue LoadError
+      config = {
+          address: 'localhost',
+          port: 27017,
+          database: 'test-db',
+          collection: 'test-collection',
+          username: 'test-user',
+          password: 'test-pass'
+      }
+    end
+    config
+  end
+
+
+  # Called after every test method runs. Can be used to tear
+  # down fixture information.
+  def teardown
+    @inspect_queue.remove
+    @inspect_queue.drop_indexes
+    @queue.destroy
+  end
+
+  def assert_empty_queue(queue = MongoDBQueue::DEFAULT_QUEUE)
+    assert_nil(@queue.dequeue(queue)) # Queue is empty
+  end
+
+  def test_initialize_no_address
+    @config.delete :address
+    exception = assert_raise(RuntimeError) {MongoDBQueue::MongoDBQueue.new(@config)}
+    assert_equal('No database address set', exception.message)
+  end
+
+  def test_initialize_no_port
+    @config.delete :port
+    exception = assert_raise(RuntimeError) {MongoDBQueue::MongoDBQueue.new(@config)}
+    assert_equal('No database port set', exception.message)
+  end
+
+  def test_initialize_no_db
+    @config.delete :database
+    exception = assert_raise(RuntimeError) {MongoDBQueue::MongoDBQueue.new(@config)}
+    assert_equal('No database set', exception.message)
+  end
+
+  def test_initialize_no_collection
+    @config.delete :collection
+    exception = assert_raise(RuntimeError) {MongoDBQueue::MongoDBQueue.new(@config)}
+    assert_equal('No collection set', exception.message)
+  end
+
+  def test_enqueue_dequeue
+    person = get_person
+    assert_not_nil @queue.enqueue(person)
+    dequeued = @queue.dequeue
+
+    assert_equal(person[:name], dequeued['name'])
+    assert_equal(person[:age], dequeued['age'])
+    assert_equal(person[:id_num], dequeued['id_num'])
+
+    assert_nil(@queue.dequeue)
+    assert_not_nil @inspect_queue.find.next_document
+  end
+  
+  def test_enqueue_dequeue_delete
+    person = get_person
+    assert_not_nil @queue.enqueue(person)
+    dequeued = @queue.dequeue(MongoDBQueue::DEFAULT_QUEUE, {delete: true})
+
+    assert_equal(person[:name], dequeued['name'])
+    assert_equal(person[:age], dequeued['age'])
+    assert_equal(person[:id_num], dequeued['id_num'])
+
+    assert_nil(@queue.dequeue)
+    assert_nil @inspect_queue.find.next_document
+  end
+  
+  def test_enqueue_dequeue_with_queue
+    person = get_person
+    assert_not_nil @queue.enqueue(person, :test_queue)
+    dequeued = @queue.dequeue(:test_queue)
+
+    assert_equal(person[:name], dequeued['name'])
+    assert_equal(person[:age], dequeued['age'])
+    assert_equal(person[:id_num], dequeued['id_num'])
+
+    assert_empty_queue(:test_queue)
+  end
+
+  def test_queue_same_doc_twice
+    assert_not_nil @queue.enqueue(get_person)
+    assert_not_nil @queue.enqueue(get_person)
+    
+    person = get_person
+
+    dequeued = @queue.dequeue
+    assert_equal(person[:name], dequeued['name'])
+    assert_equal(person[:age], dequeued['age'])
+    assert_equal(person[:id_num], dequeued['id_num'])
+
+    dequeued2 = @queue.dequeue
+    assert_equal(person[:name], dequeued2['name'])
+    assert_equal(person[:age], dequeued2['age'])
+    assert_equal(person[:id_num], dequeued2['id_num'])
+
+    assert_empty_queue
+  end
+
+  def test_queue_unique_doc_twice
+    person1 = get_person
+    person2 = get_person
+    
+    person1[:id_num] = 123
+    person2[:id_num] = person1[:id_num]
+    
+    assert_not_nil @queue.enqueue(person1, :test_queue, {unique_field: :id_num})
+    assert_nil @queue.enqueue(person2, :test_queue, {unique_field: :id_num})
+
+    dequeued = @queue.dequeue(:test_queue)
+    assert_equal(person1[:name], dequeued['name'])
+    assert_equal(person1[:age], dequeued['age'])
+    assert_equal(person1[:id_num], dequeued['id_num'])
+
+    assert_empty_queue(:test_queue)
+  end
+  
+  def test_add_queue
+    assert_not_nil @queue.enqueue(get_person, :test_queue, {unique_field: :id_num})
+    assert_not_nil @queue.enqueue(get_person, [:test_queue, :test_queue2], {unique_field: :id_num})
+
+    person = get_person
+
+    dequeued = @queue.dequeue(:test_queue)
+    assert_equal(person[:name], dequeued['name'])
+    assert_equal(person[:age], dequeued['age'])
+    assert_equal(person[:id_num], dequeued['id_num'])
+
+    dequeued = @queue.dequeue(:test_queue2)
+    assert_equal(person[:name], dequeued['name'])
+    assert_equal(person[:age], dequeued['age'])
+    assert_equal(person[:id_num], dequeued['id_num'])
+
+    assert_empty_queue(:test_queue)
+    assert_empty_queue(:test_queue2)
+  end
+
+  def test_no_queue
+    assert_nil @queue.enqueue(get_person, [nil, ''])
+  end
+
+  def test_remove_all_with_status_same
+    # q1 & q2 => success
+    @queue.enqueue(get_person, [:queue1, :queue2])
+    @queue.dequeue(:queue1, {status: :success}) 
+    @queue.dequeue(:queue2, {status: :success})
+    assert_equal(1, @queue.remove_all(:success))
+    assert_equal(0, @queue.remove_all(:success))
+  end
+
+  def test_remove_all_with_status_multiple
+    # q1 => success, q2 => error
+    @queue.enqueue(get_person, [:queue1, :queue2])
+    @queue.dequeue(:queue1, {status: :success})
+    @queue.dequeue(:queue2, {status: :error})
+    assert_equal(1, @queue.remove_all([:success, :error]))
+    assert_equal(0, @queue.remove_all([:success, :error]))
+  end
+
+  def test_remove_all_with_status_single
+    # q1 => success, q2 => error
+    @queue.enqueue(get_person, [:queue1])
+    @queue.dequeue(:queue1, {status: :success})
+    assert_equal(1, @queue.remove_all([:success, :error]))
+    assert_equal(0, @queue.remove_all([:success, :error]))
+  end
+
+  def test_remove_all_not_qualified
+    # q1 => success, q2 => processing
+    @queue.enqueue(get_person, [:queue1, :queue2])
+    @queue.dequeue(:queue1, {status: :success})
+    @queue.dequeue(:queue2, {status: :processing})
+    assert_equal(0, @queue.remove_all([:success, :error]))
+  end
+  
+  def test_requeue_timed_out
+    @queue.enqueue(get_person)
+    @queue.dequeue
+    sleep 0.1
+    assert_nil @queue.dequeue
+    assert_equal(1, @queue.requeue_timed_out(0.1, MongoDBQueue::DEFAULT_DEQUEUE_STATUS))
+    assert_not_nil @queue.dequeue
+  end
+  
+  def test_requeue_timed_out_young
+    @queue.enqueue(get_person)
+    @queue.dequeue
+    assert_nil @queue.dequeue
+    assert_equal(0, @queue.requeue_timed_out(5, MongoDBQueue::DEFAULT_DEQUEUE_STATUS))
+    assert_nil @queue.dequeue
+  end
+  
+  def test_requeue_timed_out_multiple
+    @queue.enqueue(get_person, [:queue1, :queue2, :queue3])
+    @queue.dequeue(:queue1, {status: :success})
+    @queue.dequeue(:queue2, {status: :error})
+    @queue.dequeue(:queue3, {status: :processing})
+    sleep 0.1
+    assert_nil @queue.dequeue(:queue1)
+    assert_nil @queue.dequeue(:queue2)
+    assert_nil @queue.dequeue(:queue3)
+    assert_equal(2, @queue.requeue_timed_out(0.1, [:error, :processing]))
+    assert_nil @queue.dequeue(:queue1)
+    assert_not_nil @queue.dequeue(:queue2)
+    assert_not_nil @queue.dequeue(:queue3)
+  end
+  
+  def test_unset_all
+    @queue.enqueue(get_person, [:queue1, :queue2])
+    @queue.dequeue(:queue1, {status: :success})
+    @queue.dequeue(:queue2, {status: :error})
+    assert_not_nil @inspect_queue.find().next_document['name']
+    assert_equal(1, @queue.unset_all([:success, :error], :name))
+    assert_nil @inspect_queue.find().next_document['name']
+  end
+
+  def test_unset_all_not_qualified
+    @queue.enqueue(get_person, [:queue1, :queue2])
+    @queue.dequeue(:queue1, {status: :success})
+    @queue.dequeue(:queue2, {status: :error})
+    assert_not_nil @inspect_queue.find().next_document['name']
+    assert_equal(0, @queue.unset_all([:success], :name))
+    assert_not_nil @inspect_queue.find().next_document['name']
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'simplecov'
+require 'simplecov-cobertura'
+
+SimpleCov.formatters = [
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::CoberturaFormatter
+]
+
+SimpleCov.coverage_dir(ENV['COVERAGE_REPORTS'])
+SimpleCov.start

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: mongodb_queue
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jesse Bowes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: ci_reporter_test_unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+description: A mongoDB based messaging queue that supports multiple queues
+email:
+- jbowes@dashingrocket.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mongodb_queue.rb
+- lib/mongodb_queue/version.rb
+- mongodb_queue.gemspec
+- shippable.yml
+- test/mongodb_queue_test.rb
+- test/test_helper.rb
+homepage: https://github.com/dashingrocket/mongodb_queue
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: MongoDB Messaging Queue
+test_files:
+- test/mongodb_queue_test.rb
+- test/test_helper.rb